This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
-
System dependencies
-
Configuration
-
Create a
.envfile from.env.exampleand setPOSTGRES_USERandPOSTGRES_PASSWORDfor local development. -
Example:
cp .env.example .env
-
-
Database creation
-
Run:
bundle exec rails db:create
-
-
Database initialization
-
Run:
bundle exec rails db:migrate
-
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...