A sample readme project for a service that needs support. This would normally be a private repository.
This is a template for a productive README.md It has been optimised for support. Keep important info at the top.
Italics are notes for this template, not real usage.
General cross project details would live here:
https://codurance.com/company/
Immediate access to the logs (presumably authenticated)
| Env |
|---|
| live |
| aslive |
Simple who uses what diagram.
Links to the services pages (normally would be equivalent to this)
| Service |
|---|
| Contentful |
| Neo4j |
If this is a website the root of the various environments
| Env | Url |
|---|---|
| live | https://somewhere |
| aslive | https://aslive.somewhere |
Useful endpoints to hit
| Usage | endpoint | Usages |
|---|---|---|
| Something | /something | someone who calls this |
| Another | /api/another | someone who calls this |
Some details of message queues used.
Some details of the databases used (tables, columns or collections)
## How to start the app
./gradlew run
yarn serve
docker-compose up