Please outline the main purpose/core features of the project in one paragraph.
- Use bullet points to describe any ways this project is reliant or relied upon by other in-house services.
- be extra helpful and add links to repos
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
You will need to have these installed before moving onto the installing section.
- package name - link to docs if possible
- package name -
$ npm install command
A step by step series of examples that tell you have to get a development env running Say what the step will be
Give the example
And repeat with as detailed as relevant and useful.
until finished
If this section involves a lot of steps, think about creating a setup.sh file that can be ran instead (this can be a useful way to document the process as well as speeding up the process for your fellow developers.
All the configuration for this project lives here: /path/to/config/dir
npm run COMMAND_NAME- add a short description
Test scripts live here path/to/tests
To run tests: npm run test
To run test coverage: npm run test:coverage
This project aims to exceed 75% test coverage.
This project follows Git Flow.
Deployments are handled by kubernetes, the config lives path/to/deployment-scripts
When deploying to Production:
- Update and commit CHANGELOG.md
git tag v1.0.0Add git tag in this format.