Map Colonies typescript script template

---

---

This is a basic repo template for building new MapColonies cli script or cron-job in Typescript.

Template Usage Notes:

• the docker file contains default command to use when running container without additional parameters
• command handlers can be async or sync functions
• naming command '$0' will make it the default command

Template Features:

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

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

• jest

• .nvmrc

• Multi stage producton-ready Dockerfile

• commitlint

• git hooks

• logging by @map-colonies/js-logger

• 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

Installation

Install deps with npm

npm install

Install Git Hooks

npx husky 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 script

npm run start -- [parameter1] [parameter 2] [...]

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