This is a Cookiecutter template. Use this template to quickly set-up a new service repository with docker, typescript, testing and coverage support.
See the Cookiecutter documentation for a full installation guide.
On Ubuntu use:
sudo apt install cookiecutter
To use this template simply execute the following command with Cookiecutter installed.
cookiecutter https://github.com/Multiflexmeter/portal-service-template
This command will prompt a few questions and then create the project in a folder named after your service. (1st question)
This template creates a Docker based Node.JS project with Typescript support. Below are a few key features:
- Typescript support
- Typescript ESLint w/ auto-format
- Mocha & Chai Unit-Testing
- NYC / Istanbul code-coverage
- Gitlab CI/CD support (missing k8s deployment)
- Dockerized project
- Develop in container
The template contains the following files:
<service name>
├────── Dockerfile
├────── LICENSE
├────── package.json
├────── pm2.json
├────── README.md
├────── src
│ └────── app.ts
├────── tests
│ └────── example.test.ts
├────── tsconfig.json
└────── yarn.lock