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.3
-
Rails version
- 5.2.3
-
System dependencies
- Mysql
-
Configuration
- .env
-
Database
docker-compose up -d db
-
Database creation
rails db:create
-
Database initialization
rails db:migrate db:seed
-
How to run the test suite
rails test
guard
-
Services (job queues, cache servers, search engines, etc.)
- TBD
-
Deployment instructions
brew install terminal-notifier
-
Reference