README
This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
2.3.2
-
System dependencies
-
Configuration
# Create a .env file and set all environment variables
cp sample.env .env
- Database creation
rails db:create && rails db:migrate
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
Job queues:
Heroku:
-
Deployment instructions
- Look in sample.env and set all environment variables listed in it.
-
...