This project centralizes the creation of GitHub issues that correspond with larger-scale goals for a GitHub repository. It should be an aide to goal-setting meetings and to retrospective meetings.
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Homebrew will be used to install later dependencies.
If you do not already have homebrew installed, run:
/usr/bin/ruby -e "$(curl -fsSL
https://raw.githubusercontent.com/Homebrew/install/master/install)"
in a terminal session.
Node.js is a JavaScript runtime. If you do not already have Node.js installed, you can download it here.
If you already have Node.js installed, be sure to use a version greater than 8.9.0.
To install JavaScript dependencies, you will need to have Yarn installed.
To install Yarn, run:
brew install yarn
To install the remaining dependencies, we will use yarn.
From the project directory, run:
yarn
This should install all of the remaining dependencies. If something goes wrong, please open an issue.
To run Goal Setter on your local server, use the following command:
yarn start
Goal Setter strives to be 100% tested to protect against regressions and to guide development.
To run the full suite of tests, run:
yarn test
To ensure 100% test coverage, you can also run:
yarn test --coverage
Goal Setter uses ESLint.
To run the code checker, run:
yarn lint
Deployment of Goal Setter is handled automatically by CI and Heroku. Merging into the production branch with passing CI results in an automatic deploy.
If any of the above documentation is unclear, please create an issue.