Skip to content

Contributing

Connor Duffy edited this page Aug 15, 2021 · 8 revisions

Environment Setup

  1. clone the project from the github repo
  2. install dependencies from the terminal of your IDE with npm i.

Optional Development Dependencies

  1. install development dependencies: npm i -D eslint eslint-config-airbnb-base eslint-plugin-import eslint-config-prettier eslint-plugin-prettier nodemon prettier
  2. run npm run dev to start the dev environment
  3. test the environment by navigating to localhost:3000

Contributing

Available project tasks are available in the Projects tab.

To contribute to the project:

  1. Select the Project tab
  2. Move a to-do list task to in progress
  3. Create a new branch with the task number and name
  4. Modify Code
  5. Submit Pull request to the main branch when a task is complete

Clone this wiki locally