README.md

Map Colonies typescript service template

---

This is a basic repo template for building new MapColonies web services in Typescript.

Important

To regenerate the types on openapi change run the command npm run generate:openapi-types.

Warning

After creating a new repo based on this template, you should delete the CODEOWNERS file.

Development

When in development you should use the command npm run start:dev. The main benefits are that it enables offline mode for the config package, and source map support for NodeJS errors.

Template Features:

• eslint configuration by @map-colonies/eslint-config

• prettier configuration by @map-colonies/prettier-config

• jest

• .nvmrc

• Multi stage production-ready Dockerfile

• commitlint

• git hooks

• logging by @map-colonies/js-logger

• OpenAPI request validation

• config load with node-config

• Tracing and metrics by @map-colonies/telemetry

• github templates

• bug report

• feature request

• pull request

• github actions

• on pull_request

• LGTM

• test

• lint

• snyk

API

Checkout the OpenAPI spec here

Installation

Install deps with npm

npm install

Run Locally

Clone the project

git clone https://link-to-project

Go to the project directory

cd my-project

Install dependencies

npm install

Start the server

npm run start

Running Tests

To run tests, run the following command

npm run test

To only run unit tests:

npm run test:unit

To only run integration tests:

npm run test:integration