jad-node-ts-kit

NodeJS - TypeScript Starter Kit

Creating a project

Create the prject by using npx: npx comes with npm 5.2+ and higher

npx jad-node-ts-kit my-awesome-project
cd my-awesome-project
yarn install

And you can directly start coding!

Starter Kit Documentation

Development

For running .ts files:

yarn ts-node <file.ts>

For development mode:

yarn nodemon

nodemon will automatically restart the aplication when file changes are detected

Linting + Prettier

yarn lint
yarn prettify

VSCode Users should add this to their workspace settings to integrate JS/TS Linting in general:

  "eslint.validate": [
    "javascript",
    "typescript",
  ]

Running tests

Run all tests:

yarn test

Run and watch all tests:

yarn test:watch

Building the App

yarn build

Building your app with CircleCI

Having already pushed your project to your favorite git-repository hosting service, you're one click away from integrating your app with CircleCI.

• Press Add Projects.
• Pinpoint your project and press Set Up Project.
• Choose Linux as the OS and Node as the language.
• Press Start Building, and you're all set! :tada:

CircleCI ensures that every commit is checked for errors before merging. This basic setup runs yarn lint, yarn test, and yarn build.

What's Included?

Your environment will have everything you need to build a modern NodeJS - Typescript application

• Typescript Support
• Jest unit testing
• ESLint and Prettier configs
• CircleCI configs