ajm5774 / KnD

Karma and Dragons
0 stars 0 forks source link

Karma and Dragons

Commands

Contributing

Project Setup

  1. Clone the repo git clone git@github.com:rbaxter08/KnD.git
  2. Install dependencies yarn
  3. Setup MongoDB
    • Download and install Mongodb
    • Add bin folder to the path (ex. C:\Program Files\MongoDB\Server\4.0\bin)
    • Add the connection string to .env file with MONGO_CONNECTION_STRING=mongodb://localhost
  4. Setup Slack
    • Request permissions to be added to dev workspace. This will add you as a collaborator for the slack app
    • Add the bot access token to .env file with SLACK_TOKEN=<bot_access_token>. The access token can be found under Features > OAuth & Permissions
  5. Start the dev server yarn start

Making Changes

  1. Create a new branch git checkout -b <your_branch_name> in the format <issue_id>-<description> (ex. "8-hot-build")
  2. After you have finished making your changes commit them. git commit -m "<your_commit_message>"
  3. Push your changes to github git push origin <your_branch_name>
  4. Create pull request
    • From Github create a Pull Request from your branch into master
    • Tag a reviewer
    • Wait for it to be reviewed and address feedback before merging