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
Create config/local_env.yml
with the following values:
- FRONTEND_URL: http://localhost:3000/
- Database creation
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...