Thank you for your interest in contributing! For any specific questions or suggestions, feel free to create a new issue with specific details.
- Fork this repository and clone your fork onto your machine.
- Make sure you have the latests versions of Node and npm installed.
- In the command line terminal, navigate to the root directory of your local clone.
- Run
npm install
to install all the development dependencies of this project. - Run
npm run build:dev
to bundle the code. - To develop on the frontend only:
- Run
npm run dev
to begin developing with local webpack server. - Open browser and enter
http://localhost:8080
as the URL.
- To develop on the server side:
- Startup local mongoDB server in separate terminal by running
mongod
(ormongod.exe
). - Run
npm run start
(doesn't track changes on server) ornpm run serve
(tracks changes both on frontend and backend). - Open browser and enter
http://localhost:8000
as the URL.
- When you are finished with all the changes, save your work, and run
npm run build:prod
to re-bundle all changes for production, andnpm start
to see production-ready app athttp://localhost:8000
. - Commit and push all files to your forked repositroy.
- When you've finished making your changes, make sure your local clone is up-to-date.
- Pull (or fetch and merge) down code from the
master
branch of the original repository. - Resolve any merge conflicts.
- Create a pull request from your forked repository into the
development
branch of the original repository. - Please follow the pull request template and include specific details about your pull request.