Skip to main content

TypeScript Server Boilerplate

This is the official MapColonies™ boilerplate for a TypeScript server using Express.js. The boilerplate includes many features and packages in order to make the development process easier and faster and ensure common practices and standards.

Where do I find it?​

The boilerplate is available in the MapColonies™ GitHub repository

How do i create a new project using the boilerplate?​

When creating a new project, you can use the boilerplate as a template repository in GitHub.

create-repo-boilerplate

Check the Getting Started guide for more information.

Important scripts​

  • npm run start:dev - Start the server in development mode.
  • npm run start - Start the server in production mode.
  • npm run test - Run the tests.
  • npm run test:unit - Run the unit tests.
  • npm run test:integration - Run the integration tests.
  • npm run lint - Lint the code.
  • npm run format:fix - Format the code.
  • npm run build - Build the project.
  • generate:openapi-types - Generate types from the OpenAPI schema.

Deep dive​

We can break down the boilerplate into the following sections:

  1. Code
  2. Tests
  3. The repository configuration and validation
  4. Deployment

Code​

The code is written in TypeScript and uses the Express.js framework. The code is organized in a modular way, with each resource having its own directory and files. The boilerplate provides a basic structure for the code, with packages that provide features that give a good starting point for a new project.

For more information on the code structure and the packages used, check the following link.

Tests​

The boilerplate includes tests for the code, using the Jest testing framework. The tests are organized in a similar way to the code, with each resource having its own test file. The tests are split into unit tests and integration tests, and provide a good starting point for writing tests for a new project.

For more information on the tests and the packages used, check the following link.

The repository configuration and validation​

In order for all the features to work correctly, there are a multitude of packages and configurations that are already set up in the boilerplate. They handle stuff like linting, formatting, testing, and more. Without all those files, maintaining standard and quality code would be a nightmare.

For more information on the repository configuration and validation, check the following link.

Deployment​

What's the point of having a project if nobody can use it? The boilerplate includes a Dockerfile and a helm chart that can be used to deploy the project to a Kubernetes cluster.