{"id":28412615,"url":"https://github.com/postlight/nodejs-typescript-kit","last_synced_at":"2025-08-30T17:39:15.608Z","repository":{"id":34260413,"uuid":"169377858","full_name":"postlight/nodejs-typescript-kit","owner":"postlight","description":"🛠 Node.js + TypeScript with all the goods: A zero-to-coding starter kit with all the modern tooling baked in.","archived":false,"fork":false,"pushed_at":"2023-02-08T21:04:58.000Z","size":341,"stargazers_count":107,"open_issues_count":9,"forks_count":14,"subscribers_count":34,"default_branch":"master","last_synced_at":"2025-06-03T11:37:55.775Z","etag":null,"topics":["jest","labs","node","nodejs","prettier","starter-kit","typescript"],"latest_commit_sha":null,"homepage":"https://postlight.com/labs/node-js-typescript-starter-kit","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/postlight.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE-APACHE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-02-06T08:56:43.000Z","updated_at":"2025-04-16T19:02:46.000Z","dependencies_parsed_at":"2025-06-03T08:34:11.091Z","dependency_job_id":null,"html_url":"https://github.com/postlight/nodejs-typescript-kit","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/postlight/nodejs-typescript-kit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postlight%2Fnodejs-typescript-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postlight%2Fnodejs-typescript-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postlight%2Fnodejs-typescript-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postlight%2Fnodejs-typescript-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/postlight","download_url":"https://codeload.github.com/postlight/nodejs-typescript-kit/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postlight%2Fnodejs-typescript-kit/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261685288,"owners_count":23194078,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jest","labs","node","nodejs","prettier","starter-kit","typescript"],"created_at":"2025-06-02T23:14:44.756Z","updated_at":"2025-06-24T13:30:52.397Z","avatar_url":"https://github.com/postlight.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Node.js + TypeScript Starter Kit](https://13c27d41k2ud2vkddp226w55-wpengine.netdna-ssl.com/wp-content/uploads/2019/05/node-js-2.png)\n\n# Node.js + TypeScript Starter Kit\n\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n[![CircleCI](https://circleci.com/gh/postlight/nodejs-typescript-kit.svg?style=svg)](https://circleci.com/gh/postlight/nodejs-typescript-kit)\n\n[Postlight](https://postlight.com)'s Node.js + TypeScript Starter Kit is a zero-config codebase that lets you start writing code immediately. It includes:\n\n* TypeScript (or write just regular ol' JavaScript)\n* Jest for testing\n* Prettier for formatting\n* ESLint for linting\n* CircleCI configs\n* Pre-commit hooks\n* Basic config and build scripts\n\nRead all about it [this handy introduction](https://postlight.com/trackchanges/introducing-postlights-node-js-typescript-starter-kit).\n\n## Creating a project\n\nCreate the project by using **npx**:\n\n_[npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher_\n\n```bash\nnpx @postlight/node-typescript-starter-kit my-awesome-project\n\ncd my-awesome-project\n```\n\nInstall dependencies using either **yarn** or **npm**\n\n```bash\nyarn install\n\n#  or\n\nnpm install\n```\n\nAnd you can directly start coding!\n\n![starterkit](https://user-images.githubusercontent.com/32297675/53011741-c68e9200-3449-11e9-8746-01bcc0fff247.gif)\n\n## Starter Kit Documentation\n\n### Development\n\nFor 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`).\n\nFor running an individual `.ts` file:\n\n```bash\nyarn ts-node \u003cfile.ts\u003e\n```\n\nFor development mode:\n\n```bash\nyarn nodemon\n```\n\n[nodemon](https://www.npmjs.com/package/nodemon) will automatically restart the application when file changes are detected. This is useful if the tool you're building executes code when run.\n\n### Linting\n\n```bash\nyarn lint\n```\n\nVSCode users should add this to their workspace settings to integrate JS/TS linting in general:\n\n```json\n  \"eslint.validate\": [\n    \"javascript\",\n    \"typescript\",\n  ]\n```\n\n### Running tests\n\nRun all tests:\n\n```bash\nyarn test\n```\n\nRun and watch all tests:\n\n```bash\nyarn test:watch\n```\n\n### Building the App\n\n```bash\nyarn build\n```\n\n## Building your app with CircleCI\n\nHaving already pushed your project to your favorite git repository hosting service, you're one click away from integrating your app with CircleCI.\n\n- Login to [CircleCI](https://circleci.com/)\n- On the left side menu, press `Add Projects`.\n- Pinpoint your project and press `Set Up Project`.\n- Choose `Linux` as the OS and `Node` as the language.\n- Press `Start Building`, and you're all set! :tada:\n\nCircleCI ensures that every commit is checked for errors before merging.\nThis basic setup runs `yarn lint`, `yarn test`, and `yarn build`.\n\n\n---\n\n🔬 A Labs project from your friends at [Postlight](https://postlight.com). Happy coding!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpostlight%2Fnodejs-typescript-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpostlight%2Fnodejs-typescript-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpostlight%2Fnodejs-typescript-kit/lists"}