Development Guidelines

Jump to bottom

Chia-Lo (Caleb) Hsu edited this page Apr 11, 2017 · 6 revisions

The following is a set of guidelines for development purposes.

Installation

Install Git and NodeJS
After cloning, install dependencies
```
$ npm install
```
Run development server
```
$ npm start
```

Testing

All tests are located in the tests folder. They can be checked after pushing on TravisCI but preferably during development. To run,

  $ npm test

Pushing

Review your own code!
- console.logs
- unused variables
Check changes out on new branch
```
$ git checkout -b yourBranchName
```

Merge with dev branch to keep things updated

$ git checkout dev
$ git pull                                                               // get latest changes
$ git checkout yourBranchName
$ git merge dev

fix any merge conflicts

Run tests
```
$ npm test
```
Check for linter errors
Push to new remote branch
```
$ git push origin yourBranchName
```
Open new pull request
- Request reviews from relevant people
- Make sure it's on the dev branch
- Fix things if tests aren't passing -- visit the CoMake TravisCI page for more details

Deployment

Navigate to website/ directory
Build files for production
```
$ npm run build
```
This part can take up to 9 minutes, so don't worry if the build hangs in the console.
Test build locally at localhost:5000
```
$ firebase serve
```
Deploy to Firebase site
```
$ firebase deploy
```