Skip to content

Meyclem/starter-typescript-node

Repository files navigation

CI testing

[starter] TypeScript NodeJS

This is a bare simple TS boilerplate. Feel free to clone it and use it as you want. You can also click on the Use this template button to create a new repo with the same structure.

In any case, feel free to use it as you want 😁👍

Dependencies

It comes with some packages pre-installed:

VS Code Setup

This project includes VS Code configuration for a consistent development experience:

Recommended Extensions

When you open this project in VS Code, you'll be prompted to install recommended extensions:

  • ESLint - JavaScript/TypeScript linting and formatting
  • Vitest - Testing framework integration

Workspace Settings

The project includes pre-configured settings for:

  • Format on save with ESLint
  • Auto-fix ESLint issues on save
  • Organize imports automatically
  • Consistent tab size (2 spaces)
  • Line length rulers at 80 and 120 characters

Usage

Installation

This boilerplate uses:

  • node 22.19.0.
  • npm (comes with Node.js)

In case you don't have them install, you can

  • use asdf which will install the right versions based on the .tool-versions file.
  • head to the nodejs website to install it manually (npm comes bundled with Node.js).

Code sample

The repo has some files that should be removed or changed at cloning time:

Local development

npm run dev

Build

npm run build

Start

npm start

Lint

You can use eslint to help you format your code.

npm run lint

Tests

🔎 The only test is there to be sure the code runs in CI without issue due to possible failed dependancy update.

npm run test

About

This is a bare simple TS boilerplate. Feel free to clone it and use it as you want.

Topics

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Contributors