/goatpad

Primary LanguageJavaScript

goatpad

Setup

  1. Fork repo to your GitHub account
  2. Clone repo to your local machine
  3. cd into your fork
  4. run npm install - this downloads all dependencies for the project
  5. from the root directory of the project - run npm start - this starts the react development client

Contributing

  1. Make sure your repo is up to date with the main project
    • Hit the fetch and merge button on GitHub
    • Run git pull on your local machine
  2. Create a branch and name it for the feature you are working on (like navbar-login) and make your changes
  3. Push your code to GitHub
  4. On GitHub, make a PR to the test branch and make sure you include the issue your PR covers in the comments (create an issue if it doesn't exist)

Please Add Documentation

You can find the ProjectLog.md file in the root of the project. Please write a short description of what you are doing as you write a new piece of the app.