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.6.5 -
Rails version
5.2.4 -
System dependencies
Rspec -
Configuration
-
Database creation
rake db:create -
Database initialization
rake db:migration
rake db:seed -
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...
-
Database structure
