https://github.com/blockcoders/nestjs-library-template
Template to generate new NestJS libraries
https://github.com/blockcoders/nestjs-library-template
Last synced: 2 months ago
JSON representation
Template to generate new NestJS libraries
- Host: GitHub
- URL: https://github.com/blockcoders/nestjs-library-template
- Owner: blockcoders
- License: mit
- Created: 2021-11-07T02:32:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-16T05:16:08.000Z (over 2 years ago)
- Last Synced: 2024-10-28T22:38:09.669Z (8 months ago)
- Language: TypeScript
- Size: 168 KB
- Stars: 21
- Watchers: 3
- Forks: 1
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
NestJS npm Library Template
### Installation
1. Clone the repo
2. Run npm/yarn install
```bash
cd nestjs-library-template
npm install
```
# Publishing
In order to publish to NPM, create a user in npmjs.com. Follow [this guide](https://dev.to/nestjs/publishing-nestjs-packages-with-npm-21fm) for a more detailed explanation.
This repo includes a Github Action that will publish the package to npm on each push to `main`, where the version in the package.json has changed. In order for this to work you need to add your NPM_TOKEN to the repository secrets
More information [here](https://github.com/marketplace/actions/npm-publish).
## Change Log
See [Changelog](CHANGELOG.md) for more information.
## Contributing
Contributions welcome! See [Contributing](CONTRIBUTING.md).
## Author
Brian Zuker (https://twitter.com/Brian_Zuker))
## License
Licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
# Shoutout
This repo was adapted from https://github.com/nestjsplus/nestjs-package-starter