{"id":19123386,"url":"https://github.com/ryaa/node-typescript-boilerplate","last_synced_at":"2026-06-20T15:31:28.782Z","repository":{"id":96214467,"uuid":"509733496","full_name":"ryaa/node-typescript-boilerplate","owner":"ryaa","description":null,"archived":false,"fork":false,"pushed_at":"2022-07-02T11:10:54.000Z","size":25,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-22T13:36:01.449Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/ryaa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":["jsynowiec"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2022-07-02T11:10:53.000Z","updated_at":"2022-07-02T11:10:57.000Z","dependencies_parsed_at":"2023-04-21T10:34:01.947Z","dependency_job_id":null,"html_url":"https://github.com/ryaa/node-typescript-boilerplate","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":"jsynowiec/node-typescript-boilerplate","purl":"pkg:github/ryaa/node-typescript-boilerplate","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryaa%2Fnode-typescript-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryaa%2Fnode-typescript-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryaa%2Fnode-typescript-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryaa%2Fnode-typescript-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ryaa","download_url":"https://codeload.github.com/ryaa/node-typescript-boilerplate/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ryaa%2Fnode-typescript-boilerplate/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34576041,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-20T02:00:06.407Z","response_time":98,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-09T05:25:29.220Z","updated_at":"2026-06-20T15:31:28.764Z","avatar_url":"https://github.com/ryaa.png","language":"TypeScript","funding_links":["https://github.com/sponsors/jsynowiec"],"categories":[],"sub_categories":[],"readme":"# node-typescript-boilerplate\n\n[![Sponsor][sponsor-badge]][sponsor]\n[![TypeScript version][ts-badge]][typescript-4-7]\n[![Node.js version][nodejs-badge]][nodejs]\n[![APLv2][license-badge]][license]\n[![Build Status - GitHub Actions][gha-badge]][gha-ci]\n\n👩🏻‍💻 Developer Ready: A comprehensive template. Works out of the box for most [Node.js][nodejs] projects.\n\n🏃🏽 Instant Value: All basic tools included and configured:\n\n- [TypeScript][typescript] [4.7][typescript-4-7]\n- [ESM][esm]\n- [ESLint][eslint] with some initial rules recommendation\n- [Jest][jest] for fast unit testing and code coverage\n- Type definitions for Node.js and Jest\n- [Prettier][prettier] to enforce consistent code style\n- NPM [scripts](#available-scripts) for common operations\n- Simple example of TypeScript code and unit test\n- .editorconfig for consistent file format\n- Reproducible environments thanks to [Volta][volta]\n- Example configuration for [GitHub Actions][gh-actions]\n\n🤲 Free as in speech: available under the APLv2 license.\n\n## Getting Started\n\nThis project is intended to be used with the latest Active LTS release of [Node.js][nodejs].\n\n### Use as a repository template\n\nTo start, just click the **[Use template][repo-template-action]** link (or the green button). Start adding your code in the `src` and unit tests in the `__tests__` directories.\n\n### Clone repository\n\nTo clone the repository, use the following commands:\n\n```sh\ngit clone https://github.com/jsynowiec/node-typescript-boilerplate\ncd node-typescript-boilerplate\nnpm install\n```\n\n### Download latest release\n\nDownload and unzip the current **main** branch or one of the tags:\n\n```sh\nwget https://github.com/jsynowiec/node-typescript-boilerplate/archive/main.zip -O node-typescript-boilerplate.zip\nunzip node-typescript-boilerplate.zip \u0026\u0026 rm node-typescript-boilerplate.zip\n```\n\n## Available Scripts\n\n- `clean` - remove coverage data, Jest cache and transpiled files,\n- `prebuild` - lint source files and tests before building,\n- `build` - transpile TypeScript to ES6,\n- `build:watch` - interactive watch mode to automatically transpile source files,\n- `lint` - lint source files and tests,\n- `prettier` - reformat files,\n- `test` - run tests,\n- `test:watch` - interactive watch mode to automatically re-run tests\n\n## Additional Information\n\n### Why include Volta\n\n[Volta][volta]’s toolchain always keeps track of where you are, it makes sure the tools you use always respect the settings of the project you’re working on. This means you don’t have to worry about changing the state of your installed software when switching between projects. For example, it's [used by engineers at LinkedIn][volta-tomdale] to standardize tools and have reproducible development environments.\n\nI recommend to [install][volta-getting-started] Volta and use it to manage your project's toolchain.\n\n### ES Modules\n\nThis template uses native [ESM][esm]. Make sure to read [this][nodejs-esm], and [this][ts47-esm] first.\n\nIf your project requires CommonJS, you will have to [convert to ESM][sindresorhus-esm].\n\nPlease do not open issues for questions regarding CommonJS or ESM on this repo.\n\n## Backers \u0026 Sponsors\n\nSupport this project by becoming a [sponsor][sponsor].\n\n## License\n\nLicensed under the APLv2. See the [LICENSE](https://github.com/jsynowiec/node-typescript-boilerplate/blob/main/LICENSE) file for details.\n\n[ts-badge]: https://img.shields.io/badge/TypeScript-4.7-blue.svg\n[nodejs-badge]: https://img.shields.io/badge/Node.js-\u003e=%2016.13-blue.svg\n[nodejs]: https://nodejs.org/dist/latest-v14.x/docs/api/\n[gha-badge]: https://github.com/jsynowiec/node-typescript-boilerplate/actions/workflows/nodejs.yml/badge.svg\n[gha-ci]: https://github.com/jsynowiec/node-typescript-boilerplate/actions/workflows/nodejs.yml\n[typescript]: https://www.typescriptlang.org/\n[typescript-4-7]: https://devblogs.microsoft.com/typescript/announcing-typescript-4-7/\n[license-badge]: https://img.shields.io/badge/license-APLv2-blue.svg\n[license]: https://github.com/jsynowiec/node-typescript-boilerplate/blob/main/LICENSE\n[sponsor-badge]: https://img.shields.io/badge/♥-Sponsor-fc0fb5.svg\n[sponsor]: https://github.com/sponsors/jsynowiec\n[jest]: https://facebook.github.io/jest/\n[eslint]: https://github.com/eslint/eslint\n[wiki-js-tests]: https://github.com/jsynowiec/node-typescript-boilerplate/wiki/Unit-tests-in-plain-JavaScript\n[prettier]: https://prettier.io\n[volta]: https://volta.sh\n[volta-getting-started]: https://docs.volta.sh/guide/getting-started\n[volta-tomdale]: https://twitter.com/tomdale/status/1162017336699838467?s=20\n[gh-actions]: https://github.com/features/actions\n[repo-template-action]: https://github.com/jsynowiec/node-typescript-boilerplate/generate\n[esm]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n[sindresorhus-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n[nodejs-esm]: https://nodejs.org/docs/latest-v16.x/api/esm.html\n[ts47-esm]: https://devblogs.microsoft.com/typescript/announcing-typescript-4-7/#esm-nodejs\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryaa%2Fnode-typescript-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fryaa%2Fnode-typescript-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fryaa%2Fnode-typescript-boilerplate/lists"}