README_MICROSERVICE_TEMPLATE.md

Project Title

A brief description of what this project does and who it's for.

This is the resource API for placeholder data in dynamodb.

Badges

Add badges from somewhere like: shields.io

This API runs at:

• local
• staging
• prod

Custodian

• Team:
• SLA: Australian Business Hours

Development

The main tech stack of this project is Typescript, AWS DynamoDB SDK and CloudRun

Prerequisites

• node
• yarn
• docker

Get started

To get started, checkout the repo and run

yarn

Start server

yarn start #API runs at http://localhost:8080/health

Run test

yarn ci

Pre check in your code

yarn pre-checkin

Run local E2E test

export NPM_TOKEN=xxxx   # or set this environment variable in your profile

yarn run:local:e2e

For other commands, please refer to package.json;

Postman collection

You can use the postman collection to run some manual tests for the endpoints.

You need to create an Environment with the following variables

• base_url
• id_token
• env

Monitoring and alerting

Splunk

• staging
• prod

Pagerduty

Alarms is sent to Team Business Hours

Datadog APM (or could be appdynamics here)

• dev
• prod

Dependabot

Dependabot is used to keep all our dependencies up to date

Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

Please adhere to this project's code of conduct.

Resources

• Team tech docs -- each team could have their own tech docs using mkdocs similar to spotify backstage approach
• Awesome Readme Templates
• Awesome README
• How to write a Good readme
• JVM microservice guide