Skip to content

Latest commit

 

History

History
28 lines (24 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

28 lines (24 loc) · 1.86 KB

Contributing to this repository

Thank you for your interest in contributing! For any specific questions or suggestions, feel free to create a new issue with specific details.

Development environment setup

  1. Fork this repository and clone your fork onto your machine.
  2. Make sure you have the latests versions of Node and npm installed.
  3. In the command line terminal, navigate to the root directory of your local clone.
  4. Run npm install to install all the development dependencies of this project.
  5. Run npm run build:dev to bundle the code.
  6. 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.
  1. To develop on the server side:
  • Startup local mongoDB server in separate terminal by running mongod (or mongod.exe).
  • Run npm run start (doesn't track changes on server) or npm run serve (tracks changes both on frontend and backend).
  • Open browser and enter http://localhost:8000 as the URL.
  1. When you are finished with all the changes, save your work, and run npm run build:prod to re-bundle all changes for production, and npm start to see production-ready app at http://localhost:8000.
  2. Commit and push all files to your forked repositroy.

Making a Pull Request

  1. When you've finished making your changes, make sure your local clone is up-to-date.
  2. Pull (or fetch and merge) down code from the master branch of the original repository.
  3. Resolve any merge conflicts.
  4. Create a pull request from your forked repository into the development branch of the original repository.
  5. Please follow the pull request template and include specific details about your pull request.