/goals-tracker

Simple session-based goal tracker for TTRPG campaigns.

Primary LanguageRuby

Build Passing Maintainability Test Coverage

Goals Tracker

Simple session-based goal tracker for TTRPG campaigns.

Dependencies

  • Ruby 3.0.0
  • Postgresql
  • Node.js with Yarn

Configuration

Database

The default username for postgres is the username of your OS user. The default password is no password.

If the postgres configuration on your machine is different, see config/database.yml.

For the production environment, the username is goals_tracker and the password is fetched from the GOALS_TRACKER_DATABASE_PASSWORD environment variable.

Database creation

Run the following to create the development and test databases and perform the migrations. The databases are ready for use afterwards.

$ rails db:create
$ rails db:migrate

How to run the test suite

$ rspec

Code coverage output can be found at coverage/index.html.

Deployment instructions

$ rails s

will run the server locally at localhost:3000.

Visit the list of all goals at localhost:3000/goals.