🛠Node.js + TypeScript with all the goods: A zero-to-coding starter kit with all the modern tooling baked in.
Postlight's Node.js + TypeScript Starter Kit is a zero-config codebase that lets you start writing code immediately. It includes:
Read all about it this handy introduction.
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!
For development, we'll assume you're using yarn
, but if you're using npm
instead, adjust the commands appropriately (namely, replace yarn
with npm run
).
For running an individual .ts
file:
yarn ts-node <file.ts>
For development mode:
yarn nodemon
nodemon will automatically restart the application when file changes are detected. This is useful if the tool you're building executes code when run.
yarn lint
VSCode users should add this to their workspace settings to integrate JS/TS linting in general:
"eslint.validate": [
"javascript",
"typescript",
]
Run all tests:
yarn test
Run and watch all tests:
yarn test:watch
yarn build
Having already pushed your project to your favorite git repository hosting service, you're one click away from integrating your app with CircleCI.
Add Projects
.Set Up Project
.Linux
as the OS and Node
as the language.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
.
🔬 A Labs project from your friends at Postlight. Happy coding!