https://github.com/gocom/npm-package-template
Personal npm package template
https://github.com/gocom/npm-package-template
Last synced: 9 months ago
JSON representation
Personal npm package template
- Host: GitHub
- URL: https://github.com/gocom/npm-package-template
- Owner: gocom
- License: mit
- Created: 2025-08-14T18:59:09.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-05T21:18:59.000Z (9 months ago)
- Last Synced: 2025-09-05T23:30:33.584Z (9 months ago)
- Language: TypeScript
- Size: 17.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
npm Package Template
=====
> [!NOTE]
> This is a personal skeleton Node library template, supporting TypeScript. The template publishes the library as a
> package to npm registry via GitHub actions, when a tag is added to the repository. GitHub Actions also use TypeDoc
> to generate API documentation from the code comments, which is published to a git branch named **docs**.
🎺 Getting started
-----
To set up a repository using the template:
* [ ] Update [package.json](./package.json) with your package name and other details.
* [ ] Update [dev/bin/release-notes](./dev/bin/release-notes) and [dev/bin/release-readme](./dev/bin/release-readme) and replace the generated repository URL and header.
* [ ] Add your `NPM_TOKEN` as a variable to the repository's or the organization's secrets.
* [ ] Add your package's typescript code to under the **src** directory. Default entrypoint is [src/index.ts](./src/index.ts), which exports become part of the publicly exported API. The [src/internal.ts](./src/internal.ts) can be used to export internal code paths to the generated API documentation.
* [ ] Run tests using the instructions found in [CONTRIBUTING.md](./CONTRIBUTING.md).
* [ ] Add your license and copyrights to [LICENSE](./LICENSE).
* [ ] Update [CHANGELOG.md](./CHANGELOG.md).
* [ ] Update [CONTRIBUTING.md](./CONTRIBUTING.md).
* [ ] Update [SECURITY.md](./SECURITY.md).
* [ ] Update [sonar-project.properties](./sonar-project.properties) and uncomment **SonarQube Scan** section in [.github/workflows/ci.yml](.github/workflows/ci.yml), if you wish to use SonarCloud.
* [ ] Update title, links, image name, usage instructions to [README.md](./README.md), and remove these **Getting started** instructions.
* [ ] Commit and push changes. Feel free to amend the first commit and overwrite the history, if you initialized the repository directly from the template. 🎉
⚡ Install
-----
Using npm:
```shell
$ npm install @gocom/npm-package-template
```
📖 Documentation
-----
See [API Docs](https://github.com/gocom/npm-package-template/blob/docs/main/Public/API.md).
🛠️ Development
-----
See [CONTRIBUTING.md](https://github.com/gocom/npm-package-template/blob/main/CONTRIBUTING.md).