Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fspoettel/node-ts-template
🧰 Template for developing Node.js projects with TypeScript.
https://github.com/fspoettel/node-ts-template
nodejs template typescript
Last synced: about 1 month ago
JSON representation
🧰 Template for developing Node.js projects with TypeScript.
- Host: GitHub
- URL: https://github.com/fspoettel/node-ts-template
- Owner: fspoettel
- License: mit
- Created: 2022-11-01T11:56:19.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-11T18:00:19.000Z (9 months ago)
- Last Synced: 2024-04-13T16:12:31.087Z (9 months ago)
- Topics: nodejs, template, typescript
- Language: TypeScript
- Homepage:
- Size: 539 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🧰 node-ts-template
Template for developing [Node.js](https://nodejs.org) projects with [TypeScript](https://www.typescriptlang.org).
Features:
- supports [ESM](https://nodejs.org/api/esm.html) and top-level `await`.
- [swc](https://swc.rs/) for faster builds and `tsconfig.paths` support.
- [tsx](https://github.com/esbuild-kit/tsx) for development.
- [vitest](https://vitest.dev/) for testing.
- [eslint](https://eslint.org) for linting.
- [prettier](https://prettier.io/) + [lint-staged](https://github.com/okonet/lint-staged) hook for code formatting.
- [github actions](https://docs.github.com/en/actions) for continuous integration.
- pre-configured [Dockerfile](https://docker.com).
- pre-configured [debugger](https://code.visualstudio.com/docs/editor/debugging) for VS code.
## Install
```sh
npm install
```
## Develop
```sh
npm run dev
```
## Debug
```sh
npm run dev:debug
```
## Check types
```sh
npm run check
```
## Build
```sh
npm run build
```
> **Note**
> `swc` does not check for type errors when building. If you want type checks during build, run `npm run check` in conjunction.
## Run built code
```
npm run start
```
## Test
```
npm run test
# run in watch mode.
npm run test:watch
# generate coverage report.
npm run test:coverage
```
## Lint
```
npm run lint
```
## Format
```
npm run fmt
```
## Path aliases
This template setting up path aliases via `tsconfig.paths`. By default, a `@` alias is configured, pointing to the `src` directory.
If you add new aliases, these have to be mirrored in:
- `.swcrc {jsc.paths}` for the aliases to work in build output.
- `vitest.config.ts {test.alias}` for the aliases to work in unit tests.
## Docker
The included `Dockerfile` uses a multi-stage build to reduce the size of the final container. Build dependencies are pruned. Code is executed as non-root user.
To run the container, use:
```
docker build -t node-ts-template .
docker run --env-file .env -p 3000:3000 node-ts-template
```
## Caveats
- Due to how ESM works, module imports from a relative path require a `.js` postfix.