loading...

Node.js + TypeScript Starter For Your Next Project

horusgoul profile image Horus Lugo ・1 min read

If you're a beginner that wants to learn TypeScript and Node, this starter may be the best choice for you. You won't need to configure anything in order to be able to develop and build your project, just clone it, install the dependencies and launch the development script, the rest is in your hands!

The current configuration handles polyfills for you using Babel, lints your code using ESLint, and makes sure everything is correct when you attempt to submit a new commit.

Here's the repo: HorusGoul/node-ts-starter

GitHub logo HorusGoul / node-ts-starter

Straightforward Node.js & TypeScript Starter

Node TypeScript Starter

Getting started

  1. Clone this repository and open it
$ git clone https://github.com/HorusGoul/node-ts-starter your-next-project
$ cd your-next-project
  1. Install dependencies
$ yarn
  1. Launch the dev mode
$ yarn dev
  1. You can start coding! The entry point is located in src/index.ts.

What's preconfigured?

The intent of this starter is to be really slim so it's not a nightmare to remove or change stuff, that's why there are just a few things preconfigured:

  • Babel
  • TypeScript
  • ESLint
  • Prettier
  • Husky pre-commit hook that runs ESLint and type checks the code base
  • A few npm scripts

Scripts

  • yarn dev. Runs the project in dev mode, which means that it won't check types and will restart with every change you make.
  • yarn build. Compiles the project to the ./dist folder.
  • yarn typecheck. Checks the typings of the project. Gets executed before trying to create a new commit but you can also…

I hope you like it, make me know if there's anything you'd like to see included or about any issue that you encounter while using it.

👋

Discussion

markdown guide