This repository has been archived on 2026-01-31. You can view files and clone it. You cannot open issues or pull requests or push a commit.
2023-08-05 14:20:15 +02:00
2023-08-05 14:20:15 +02:00
2023-07-18 21:48:58 +02:00
2023-07-18 21:48:58 +02:00
2023-07-18 21:38:48 +02:00
2023-08-04 21:41:44 +02:00
2023-08-05 14:20:15 +02:00
2023-08-04 21:41:44 +02:00
2023-08-05 14:20:15 +02:00

This is a template for a Node project with TypeScript

It contains basic configurations for the following:

  • TypeScript (typechecking and building)
  • Eslint (linting)
  • Prettier (formatting)
  • Jest/Supertest (testing)
  • Husky (pre-commit hooks to run linting, typechecking, and commit message format)
  • GitHub Actions (CI/CD)

Commands

Install dependencies:

yarn

Audit:

yarn audit

Lint:

yarn lint

Typecheck:

yarn typecheck

Format:

yarn format

Husky hooks:

yarn prepare

Test:

yarn test

Run in development mode:

yarn dev

Build:

yarn build

Run:

node build/index.js

To commit a WIP skipping checks:

git commit -m "WIP: <message>" --no-verify

Description
Template for NodeJS APIs with TypeScript, with configurations for linting and testing
Readme MIT 972 KiB
Languages
TypeScript 92.2%
Dockerfile 7.8%