{"id":16423354,"url":"https://github.com/ngekoding/ts-starter-library","last_synced_at":"2025-02-25T01:40:23.765Z","repository":{"id":229195483,"uuid":"776080217","full_name":"ngekoding/ts-starter-library","owner":"ngekoding","description":"Starter template to create typescript library","archived":false,"fork":false,"pushed_at":"2024-03-23T09:57:55.000Z","size":85,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-22T22:07:05.579Z","etag":null,"topics":["js-library","library-template","ts-library"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/ngekoding.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":"2024-03-22T16:34:18.000Z","updated_at":"2024-03-23T08:38:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"682d5330-a409-4945-bf1e-cdb9ab8f78cb","html_url":"https://github.com/ngekoding/ts-starter-library","commit_stats":null,"previous_names":["ngekoding/ts-starter-library"],"tags_count":1,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngekoding%2Fts-starter-library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngekoding%2Fts-starter-library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngekoding%2Fts-starter-library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ngekoding%2Fts-starter-library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ngekoding","download_url":"https://codeload.github.com/ngekoding/ts-starter-library/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240587517,"owners_count":19825003,"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":["js-library","library-template","ts-library"],"created_at":"2024-10-11T07:39:34.710Z","updated_at":"2025-02-25T01:40:23.538Z","avatar_url":"https://github.com/ngekoding.png","language":"JavaScript","readme":"# ts-starter-library\n\nStarter template to create typescript library.\n\n## Features\n\nWe've already taken care of the configuration so you can dive straight into building your dream library.\n\n- **ESLint**: Auto fix for formatting with [@antfu/eslint-config](https://github.com/antfu/eslint-config).\n- **Commitlint**: Commit message conventions.\n- **Jest**: Unit testing.\n- **Bumpp**: Version management.\n- **Output**: CommonJS and ESM.\n\n## Getting started\n\n1. Create new repository by clicking [Use this template](https://github.com/new?template_name=ts-starter-library\u0026template_owner=ngekoding).\n2. Complete creating repository based on the library that will you build like name and description.\n3. Clone the repository to your computer.\n4. Open and modify `package.json` to fit your library: name, description, author, etc.\n\u003e Make sure the library `name` is available on NPM registry. Check it by opening [npmjs.com](https://npmjs.com) and search for the library `name`, and if there is no package found, so it is available to use.\n\n_The repository name and description is mostly the same as what we use in the package.json, so you can check the availability when creating the repository._\n\n5. Start building your library\n\n## Publishing\n\nBefore publishing the library, it is good to make sure the library running well by making a test. You can found the example in `test` directory.\n\nPublishing to NPM registry needing an account, so if you don't have an account yet, visit the [NPM sign up](https://www.npmjs.com/signup) to create one.\n\n1. Login\n\nOpen terminal and run the npm login command.\n\n```sh\nnpm login\n```\n\nComplete the login process as prompted.\n\n2. Publishing\n\n```sh\nnpm run release\n```\n\nYou will prompted to choose the library version. It is good to follow the [semantic versioning](https://docs.npmjs.com/about-semantic-versioning).\n\nIf all goes well, you will get a message telling that the library is successfully published to the NPM registry.\n\n### Further more\n\nWhat we do above is creating unscoped public packages like many general NPM packages. Then you can found detailed about this topic in [Contributing packages to the registry](https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry).\n\n## License\n\n[MIT](./LICENSE) License © 2024-PRESENT [Nur Muhammad](https://github.com/ngekoding)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fngekoding%2Fts-starter-library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fngekoding%2Fts-starter-library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fngekoding%2Fts-starter-library/lists"}