This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
Ruby 2.5.0
bin/rails db:setup
bin/rails db:migrate
bin/rails db:seed
PostgreSQL is the only external service this app uses. See below for dev setup of PostgreSQL using Docker.
Docker is required for dev setup. It's easy to install from here. It is used to run PostgreSQL. So if you have PostgreSQL installed locally, you'll need to stop the service.
- Clone the repo and
cd
into the directory. - Install all dependencies with
bundle install --path=vendor/bundle --binstubs=bin/bundle
. - Get PostgreSQL running with
docker-compose up
(you can usedocker-compose up -d
to run in the background, but don't forget to rundocker-compose down
to stop it when you're done.). - Follow Database creation and Database initialization steps above.
bin/rails server