Skip to content

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

License

Notifications You must be signed in to change notification settings

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:

Usage

Installation

The boilerplate uses:

  • node 20.12.2.
  • yarn 1.22.19

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 and yarn websites to install them manually.

Code sample

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

Start the main file

yarn start

Build the JS files

yarn build

Linter

You can use eslint to help you format your code.

yarn lint

Tests

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

yarn 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

Stars

Watchers

Forks