{"id":19977851,"url":"https://github.com/devbyray/typescript-npm-library-starter","last_synced_at":"2026-04-15T13:31:40.004Z","repository":{"id":50780066,"uuid":"236954357","full_name":"devbyray/typescript-npm-library-starter","owner":"devbyray","description":"A minimal TypeScript NPM Library Starterkit","archived":false,"fork":false,"pushed_at":"2021-05-30T00:46:33.000Z","size":433,"stargazers_count":1,"open_issues_count":4,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-11T20:55:04.315Z","etag":null,"topics":["javascript","library","npm","starter","starter-kit","template","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/devbyray.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-01-29T10:15:39.000Z","updated_at":"2022-01-31T01:21:49.000Z","dependencies_parsed_at":"2022-08-24T00:51:14.727Z","dependency_job_id":null,"html_url":"https://github.com/devbyray/typescript-npm-library-starter","commit_stats":null,"previous_names":["raymonschouwenaar/typescript-npm-library-starter"],"tags_count":4,"template":true,"template_full_name":null,"purl":"pkg:github/devbyray/typescript-npm-library-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devbyray%2Ftypescript-npm-library-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devbyray%2Ftypescript-npm-library-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devbyray%2Ftypescript-npm-library-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devbyray%2Ftypescript-npm-library-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devbyray","download_url":"https://codeload.github.com/devbyray/typescript-npm-library-starter/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devbyray%2Ftypescript-npm-library-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31842850,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-15T13:28:40.153Z","status":"ssl_error","status_checked_at":"2026-04-15T13:28:29.396Z","response_time":63,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["javascript","library","npm","starter","starter-kit","template","typescript"],"created_at":"2024-11-13T03:29:33.962Z","updated_at":"2026-04-15T13:31:39.989Z","avatar_url":"https://github.com/devbyray.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Typescript NPM Library Starter\n\nStarter for a NPM package build with TypeScript goodness 🚀\n\nCheck the [example NPM package](https://www.npmjs.com/package/typescript-npm-library-starter) based on this repo.\n\n## How to use\n\nIf you want to create a small or big JavaScript/TypeScript library to push it to NPM (or other platform). You don't want to worry about setting up a development environment and just want to start building as soon as possible.\n\nThis repo is a template for your library and ready to publish on NPM.\n\n![](./github-template-repo.png)\n\nJust click on the green button to create your repo based on this one. It's just that easy 👍\n\nClone it to your computer, run `npm install` and start building!\n\n## Requirements\n\n- TypeScript \u003e= v3.7.4\n- NodeJS \u003e= v13.3\n- NPM \u003e= v6.13.6\n\n## Workflow\n\n1. Build your functionality\n2. Run a build with `npm run build`\n3. Commit changes\n4. Create a git tag\n5. Run `npm run version` to push all commits and tags\n6. Run `npm publish` to run all linting, formatting, build and publish it on NPM\n\n## Dependencies\n\n### Generate recommended documentation/files to improve contribution\n\nThe following files are generated by the [CGX CLI](https://github.com/jeroenouw/cgx).\n\nRun `npm run cgx` to start the CLI.\n\n- CODE_OF_CONDUCT.md\n- CONTRIBUTION.md\n- .github/\n  - ISSUE_TEMPLATE\n  - PULL_REQUEST_TEMPLATE\n\nCGX offers options for Github, Gitlab, Bitbucket and will expand in future versions.\n\n### TypeScript Type Coverage\n\nFor checking the type coverage in TypeScript, we used the [TSCOV CLI](https://github.com/jeroenouw/liftr-tscov) by the Liftr framework.\n\nRun `npm run tscov` to check your types.\n\n### Code formatting\n\nTo make sure that everyone, who works on your library formats it's code equally, we included [TSlint](https://palantir.github.io/tslint/) with a plugin for [Prettier](https://prettier.io/).\n\nIn the `.prettierrc` you can change the settings to your preferences.\n\n### Testing\n\nFor running tests against your code we included [Jest](https://jestjs.io/). Jest is a JavaScript/TypeScript testing framework with a focus on simplicity, that's why we like it so much!\n\nRun `npm run test` for 1 time only run. If you want to use the Jest watch option, run `npm run test:watch`.\n\n## Example readme content\n\n## Installation\n\n```bash\nnpm install typescript-npm-library-starter\n```\n\n## How to\n\n```javascript\nimport { Car } from 'typescript-npm-library-starter';\n\nconst car = new Car();\n\n// add more of the example here\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevbyray%2Ftypescript-npm-library-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevbyray%2Ftypescript-npm-library-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevbyray%2Ftypescript-npm-library-starter/lists"}