Minimum Viable REadme

README.md

Description

https://api.example.com

This is the CRUD api for example.com

Development

1. This application requires node.js and npm
2. Copy .env.example to .env and update dummy values.
3. npm install - Install dependencies
4. npm start - Start local server

Deployment

Staging

Merging to master automatically triggers a staging build and deployment.

Production

Pushing a tag matching the pattern release-vX.X.X triggers a production build and deployment

Monitoring

• Application exceptions can be found at https://sampleExceptiontracker.com/myProject
• General application logs can be found at https://sampleloggingtool.com/myProject
• A real-time dashboard for user metrics is at https://sampleKibanaMetricsDash.com/myproject