Swagger UI documentation is available here. When running the server locally, it is served at http://localhost:3030/docs/.
- node.js
- mongoDB
- Clone directory into local folder
- Go into the cloned folder and enter
npm install
- Go into project folder
- run
mongod
- run
npm start
- Take the last part of the url of your Trello ticket (e.g. "8-setup-feather-js")
- Name the branch "yourname/trelloid" (e.g. "nico/8-setup-feather-js")
- Go into project folder
- run
npm run test
- Create a folder for the "service" you're working on in "/test/services"
- Create a file "user.test.js" for frontend tests (e.g. clicking a link or check if url is available)
- Create a file "unit.test.js" for backend tests (e.g. calculating a number)
Try to cover as many methods as possible unit test wise - goal is 100% of course, so one test per method.
Default branch: develop
- Go into project folder
- Run the tests (see above)
- Commit with a meanigful commit message(!) even at 4 a.m. and not stuff like "dfsdfsf"
- Checkout to master branch
- Run
git pull
- Checkout to the branch you want to upload
- run
git rebase -p develop
(notgit merge
!) and solve merge conflicts if needed - run
git push