{"id":19274021,"url":"https://github.com/sbstjn/typescript-npm-boilerplate","last_synced_at":"2025-04-21T22:33:27.735Z","repository":{"id":57383877,"uuid":"99206404","full_name":"sbstjn/typescript-npm-boilerplate","owner":"sbstjn","description":"Publish to NPM with TypeScript, CircleCI and GitHub Releases.","archived":false,"fork":false,"pushed_at":"2022-08-20T21:10:10.000Z","size":42,"stargazers_count":14,"open_issues_count":1,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-16T06:20:24.600Z","etag":null,"topics":["boilerplate","circleci","coveralls","js","kickstart","npm","ts","typescript"],"latest_commit_sha":null,"homepage":"https://sbstjn.com/deploy-typescript-npm-with-circleci-workflows.html","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sbstjn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-03T07:54:29.000Z","updated_at":"2024-07-31T01:45:12.000Z","dependencies_parsed_at":"2022-09-14T00:52:34.493Z","dependency_job_id":null,"html_url":"https://github.com/sbstjn/typescript-npm-boilerplate","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Ftypescript-npm-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Ftypescript-npm-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Ftypescript-npm-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sbstjn%2Ftypescript-npm-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sbstjn","download_url":"https://codeload.github.com/sbstjn/typescript-npm-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250145320,"owners_count":21382393,"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":["boilerplate","circleci","coveralls","js","kickstart","npm","ts","typescript"],"created_at":"2024-11-09T20:44:50.308Z","updated_at":"2025-04-21T22:33:22.719Z","avatar_url":"https://github.com/sbstjn.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TypeScript NPM Boilerplate\n\n[![npm](https://img.shields.io/npm/v/typescript-npm-boilerplate.svg)](https://www.npmjs.com/package/typescript-npm-boilerplate)\n[![CircleCI](https://img.shields.io/circleci/project/github/sbstjn/typescript-npm-boilerplate/master.svg)](https://circleci.com/gh/sbstjn/typescript-npm-boilerplate)\n[![license](https://img.shields.io/github/license/sbstjn/typescript-npm-boilerplate.svg)](https://github.com/sbstjn/typescript-npm-boilerplate/blob/master/LICENSE.md)\n[![Coveralls](https://img.shields.io/coveralls/sbstjn/typescript-npm-boilerplate.svg)](https://coveralls.io/github/sbstjn/typescript-npm-boilerplate)\n\nA basic boilerplate to write JavaScript NPM modules in TypeScript. The TypeScript code is compiled to JavaScript and published to NPM using CircleCI v2 Workflows and GitHub Releases.\n\nMore details at: https://sbstjn.com/deploy-typescript-npm-with-circleci-workflows.html\n\n## Features\n\n- [TypeScript](tsconfig.json) with [linting](tslint.json)\n- [Unit testing with Jest](test)\n- Coverage reports with [Coveralls](https://coveralls.io)\n- Test and PR checks with [CircleCI](circle.yml)\n- Publish with [GitHub Releases](https://github.com/sbstjn/typescript-npm-boilerplate/releases)\n\n## Usage\n\nFork this repository, download it, or clone it and add your custom files and configurations.\n\n### NPM Tasks\n\n- `test` - *Run jest*\n- `test:cover` - *Run jest and create coverage report*\n- `coveralls` - *Publish coverage report to Coveralls*\n- `lint` - *Run tslint*\n- `build` - *Build JavaScript files*\n\n## Configuration\n\n### CircleCI\n\nYou need to configure two environment variables in CircleCI, one for publishing to NPM and one for Coveralls coverage reports. \n\n- `NPM_TOKEN`\n- `COVERALLS_REPO_TOKEN`\n\n## License\n\nFeel free to use the code, it's released using the [MIT license](LICENSE.md).\n\n## Contribution\n\nYou are welcome to contribute to this project! 😘 \n\nTo make sure you have a pleasant experience, please read the [code of conduct](CODE_OF_CONDUCT.md). It outlines core values and beliefs and will make working together a happier experience.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbstjn%2Ftypescript-npm-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsbstjn%2Ftypescript-npm-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsbstjn%2Ftypescript-npm-boilerplate/lists"}