Points

Points is an open source estimation tool. It can be used to create projects, stories for projects, and blind estimates for project proposals and planning.

Getting Started

To get started with the app, clone the repo and then install the needed gems:

$ bundle install

Next, migrate the database:

$ rails db:migrate

Environment Variables

Examples

ORGANIZATION_LOGIN=
GITHUB_APP_ID=
GITHUB_APP_SECRET=

GITHUB_APP_ID and GITHUB_APP_SECRET: You need to sign up for an OAuth2 Application ID and Secret on the GitHub Applications Page.

ORGANIZATION_LOGIN: This is the organization name as it appears in the Github URL, for instance “orgname’ in https://github.com/orgname. It is needed to check if users are a part of the organization.

Starting the Server

 $ rails s

Go to http://localhost:3000

Running Tests

$ rails spec

Deploy with Heroku

Follow the steps to creating a new app on Heroku.

Add these enviornement variables to Heroku:

See above in Environment Variables section if you are unsure of where to get these variables.

ORGANIZATION_LOGIN
GITHUB_APP_ID
GITHUB_APP_SECRET

Required Heroku Add-Ons:

heroku-postgresql

Dynos (Hobby Dynos)

bin/rails server -p ${PORT:-5000} -e $RAILS_ENV

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/fastruby/points. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Points project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

OmbuLabs