{"id":20669471,"url":"https://github.com/jiifw/node-ts-boilerplate","last_synced_at":"2026-04-09T19:51:03.724Z","repository":{"id":48790541,"uuid":"517029032","full_name":"jiifw/node-ts-boilerplate","owner":"jiifw","description":"Minimalistic boilerplate to quick-start Node.js development in TypeScript.","archived":false,"fork":false,"pushed_at":"2025-02-03T11:22:41.000Z","size":334,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-03T11:39:04.659Z","etag":null,"topics":["backend","boilerplate","cjs-modules","eslint","express","fastify","javascript","jest","microservices","node-js","node-typescript-boilerplate","nodejs","nodejs-server","prettier","project-template","serverless","service","starter-template","typescript","typescript-boilerplate"],"latest_commit_sha":null,"homepage":"","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/jiifw.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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}},"created_at":"2022-07-23T10:41:00.000Z","updated_at":"2025-02-03T11:22:45.000Z","dependencies_parsed_at":"2025-02-03T11:30:36.001Z","dependency_job_id":"c6a523c7-3e6a-46fe-86fa-9bb004fba96b","html_url":"https://github.com/jiifw/node-ts-boilerplate","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jiifw%2Fnode-ts-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jiifw%2Fnode-ts-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jiifw%2Fnode-ts-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jiifw%2Fnode-ts-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jiifw","download_url":"https://codeload.github.com/jiifw/node-ts-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242884474,"owners_count":20201124,"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":["backend","boilerplate","cjs-modules","eslint","express","fastify","javascript","jest","microservices","node-js","node-typescript-boilerplate","nodejs","nodejs-server","prettier","project-template","serverless","service","starter-template","typescript","typescript-boilerplate"],"created_at":"2024-11-16T20:14:28.968Z","updated_at":"2025-12-30T19:07:43.261Z","avatar_url":"https://github.com/jiifw.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# NodeJS TypeScript Minimal Boilerplate (v0.2)\n\nDeveloper Ready: A comprehensive template. Works out of the box for most [Node.js](https://nodejs.org) projects.\n\nInstant Value: All basic tools included and configured:\n\n- [TypeScript](https://www.typescriptlang.org/) 5.7+.\n- Using [Babel-node](https://babeljs.io/docs/en/babel-node) for transpilation.\n- [ESLint](https://eslint.org/) with some initial rules' recommendation.\n- [Jest](https://jestjs.io/) for fast unit testing and code coverage.\n- Type definitions for Node.js and Jest.\n- [Prettier](https://prettier.io/) to enforce consistent code style.\n- NPM [scripts](#available-scripts) for common operations.\n- .editorconfig for consistent file format.\n- Simple example of TypeScript code and unit test.\n- Use all ES6 features *(including experimental and proposal)*.\n- Minimal `.env` files for environment customization.\n- Clean imports: No relative files path.\n- Zero dependencies: Install your own packages.\n- `yarn` PM by default.\n- `pm2` as a process manager\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,\n1. Install PM2 process manager: `yarn global add pm2` or `npm i -g pm2`.\n2. Clone this repository.\n3. Copy `.env.sample` to `.env`.\n4. Install packages: `yarn install` or `npm i`.\n5. 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/jiifw/node-ts-boilerplate\ncd node-ts-boilerplate\nyarn\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/jiifw/node-ts-boilerplate/archive/main.zip -O node-ts-boilerplate.zip\nunzip node-ts-boilerplate.zip \u0026\u0026 rm node-ts-boilerplate.zip\n```\n\n## Available Scripts\n\n- `start` - serve built project.\n- `start:dev` - interactive watch mode to automatically transpile source files.\n- `start:debug` - interactive watch mode with debugger to automatically transpile source files.\n- `clean` - remove coverage data, Jest cache, transpiled files and runtime files.\n- `prebuild` - lint source files and tests before building.\n- `build` - transpile TypeScript to ES6 (node compatible).\n- `build:prod` - transpile TypeScript to ES6 for production *(minified)*.\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- `pm2:start` - [PM2](https://pm2.keymetrics.io/) specific start service(s).\n- `pm2:stop` - [PM2](https://pm2.keymetrics.io/) specific stop service(s).\n- `pm2:delete` - [PM2](https://pm2.keymetrics.io/) specific delete service(s).\n\n## Additional Information\n\n### CommonJS Modules\n\nThis template uses native *CommonJS*.\n\nPlease do not open issues for questions regarding ESM or TS-Node on this repo.\n\n## License\n\nLicensed under the APLv2. See the [LICENSE](https://github.com/jiifw/node-ts-boilerplate/blob/main/LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjiifw%2Fnode-ts-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjiifw%2Fnode-ts-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjiifw%2Fnode-ts-boilerplate/lists"}