This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
An overview on the whole system or link(s) to the docs explaining it.
Main components for this service or links to the docs explaining them.
Links to the Grafana business and tech related dashboards.
DB engine, cache tooling, job queues, cache servers, search engines, etc.
How to get your local environment ready to start working.
How to run the tests
How to deploy your service in sandbox or production
| What | Production | Sandbox | Development |
|---|---|---|---|
| app home | |||
| sidekiq | |||
| ... |