This is the Github repository for UCSD CSSA Short Term Leasing Platform.
After cloning this repo to the local repository, please first go into the directory and type
$ npm install
This will install all the dependencies as well as run the setup script, which might furthermore install some global script to your machine.
Additionally, we recommend using Atom as your main text editor. To make the best use of Atom, install the following plugins:
- flow-ide: The Flow Typing Support
- language-babel: The Babel Language Support
To develop, please use
$ npm run dev
We have nodemon and Webpack Dev Server setup correctly so you don't need to refresh the webpage nor restart the dev server. You can just write your codes in your editor and see the changes happen on the website.
Note that, if your code involves dealing with back-end requests, you should also run a back-end server separately.
To deploy, you need to first build the code:
$ npm run build
This will generate a src/build/ directory consists of the built css and js files. After that,
you can type
$ npm run server
To start the real express server which we will be using on any server.
Everytime you start to do something, please open a new branch and push to that branch. After that, submit pull request on Github and let us do code review together.
Note that, before you push your code, please do run
$ npm run linter
That will run the linters - including eslint with Airbnb ESLint setup, scss-lint with Airbnb CSS setup, and flow type check. Please fix the pop-up problems with your code and make sure there's no linter errors when you submit the pull request.