This is a basic repo template for building new MapColonies web services in Typescript.
-
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
Checkout the OpenAPI spec here
Install deps with npm
npm install
npx husky install
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
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