Node.js + TypeScript Starter Kit
Postlight's Node.js + TypeScript Starter Kit is a zero-config codebase that lets you start writing code immediately. It includes:
- Jest for testing
- Prettier for formatting
- ESLint for linting
- CircleCI configs
- Pre-commit hooks
- Basic config and build scripts
Read all about it this handy introduction.
Creating a project
Create the project by using npx:
npx comes with npm 5.2+ and higher
npx @postlight/node-typescript-starter-kit my-awesome-project cd my-awesome-project
Install dependencies using either yarn or npm
yarn install # or npm install
And you can directly start coding!
Starter Kit Documentation
For development, we'll assume you're using
yarn, but if you're using
npm instead, adjust the commands appropriately (namely, replace
For running an individual
yarn ts-node <file.ts>
For development mode:
nodemon will automatically restart the application when file changes are detected. This is useful if the tool you're building executes code when run.
VSCode users should add this to their workspace settings to integrate JS/TS linting in general:
Run all tests:
Run and watch all tests:
Building the App
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.
- Login to CircleCI
- On the left side menu, press
- Pinpoint your project and press
Set Up Project.
Linuxas the OS and
Nodeas the language.
Start Building, and you're all set!
CircleCI ensures that every commit is checked for errors before merging.
This basic setup runs
yarn test, and