This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
ruby 2.5 or higher -
System dependencies
-
Configuration
-
Database creation
rails db:create -
Database initialization
rails db:migrate -
How to run the test suite
rake test -
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...