Developed as a class project in a team of 7 students.
- Clone the repo.
git clone
- Install the dependencies.
npm install
- Start the node process
npm start # Mac
npm run startwin # Windows
- First switch to dev branch, and do a git fetch and pull to update your local repo to the latest.
git checkout dev
git fetch --all
git pull
- Create a new branch for the specific feauture you are working on.
git checkout -b my-new-feature-branch
- Track all the new files by adding them to the repo and commit your changes.
git add .
git commit -a -m "a commit message"
- Push your branch to the repo and create a pull request from github
git push origin my-new-feature-brach
- Make sure to switch back to the dev branch and create another branch before starting to work on aother feauture.
git checkout dev
To maintain coding structure and following standards, this project uses ESLint.
npm run lint
We are using nodmon for which restarts the nodejs application automatically whenever it detects a file change. The nodemon script is already added to the "npm start" command in the package.json file.