Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rjlopezdev/nestjs-lib-starter
:package: :cat2: A Starter for Nestjs Library Development
https://github.com/rjlopezdev/nestjs-lib-starter
library nestjs schematics template
Last synced: about 2 months ago
JSON representation
:package: :cat2: A Starter for Nestjs Library Development
- Host: GitHub
- URL: https://github.com/rjlopezdev/nestjs-lib-starter
- Owner: rjlopezdev
- License: mit
- Created: 2020-02-17T18:54:06.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T07:39:52.000Z (about 2 years ago)
- Last Synced: 2024-11-04T10:58:39.114Z (2 months ago)
- Topics: library, nestjs, schematics, template
- Language: JavaScript
- Homepage: https://rjlopezdev.github.io/nestjs-lib-starter/
- Size: 3.52 MB
- Stars: 18
- Watchers: 3
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
> :bulb: See [CONFIGURE_TEMPLATE.md](https://gist.github.com/rjlopezdev/f2c2ab0db522aad87c98fb1dc2e4ef14) to configure this template. Then, remove the file and this advise.
Nest Library Starter
Minimal library description.
Contributing
·
License
> :books: [See complete documentation](https://rjlopezdev.github.io/nestjs-lib-starter/)
An exhaustive description of the library.
# :notebook: Summary
* [Installation](#installation)
* [Setup](#setup)
* [Usage](#usage)
* [LibraryNameService](#librarynameservice)
* [Schematics](#schematics)
# :package: Installation
* :cat2: Using Nest CLI:
```
nest add nestjs-library-starter
```
* :package: Using Package Manager:
```
npm install --save nestjs-library-starter
```
# :wrench: Setup
Explain your library setup.
```typescript
import { Module } from '@nestjs/common';
import { LibraryNameModule, LibraryNameConfig } from 'nestjs-library-starter';
const CONFIG: LibraryNameConfig = {
value: 'Awesome!'
}
@Module({
imports: [
...
LibraryNameModule.register(CONFIG)
],
controllers: [ ... ],
providers: [ ... ],
})
export class AppModule {}
```
## :control_knobs: Config
| Value | Type | Default | Description |
| --- | --- | --- | --- |
| value | __string__ | `` | A powerful value |
# :books: Usage
Explain your library usage.
## LibraryNameService
A service with an awesome & helpul functionallity.
| Method | Signature | Description |
| --- | --- | --- |
printConfig | __config__: `LibraryNameConfig` | Prints a provided _configuration_ |
# :art: Schematics
Invoke Schematics using:
```
nest g [params] --collection nestjs-library-starter
```
## demo
> Prints a cute cat.
| Parameter | Type | Default | Description |
| --- | --- | --- | --- |
| __catType__ | _string_ | Default | Type of cat to print.