Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arman2409/nestjs-readme
NPM package for generating documentation for Nest.js projects
https://github.com/arman2409/nestjs-readme
documentation nestjs npm-package readme
Last synced: 10 days ago
JSON representation
NPM package for generating documentation for Nest.js projects
- Host: GitHub
- URL: https://github.com/arman2409/nestjs-readme
- Owner: Arman2409
- License: mit
- Created: 2024-06-27T09:59:06.000Z (4 months ago)
- Default Branch: develop
- Last Pushed: 2024-08-04T12:53:30.000Z (3 months ago)
- Last Synced: 2024-10-11T15:16:38.282Z (26 days ago)
- Topics: documentation, nestjs, npm-package, readme
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/nestjs-readme
- Size: 89.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Nestjs-readme
`Generate basic README.md file for your Nest.js project`
- [Usage](#usage)
- [Available Commands](#commands)
- [Features](#features)
Usage
#### Installation
```bash
npm install nestjs-readme
```
#### Usage
```bash
npx nestjs-readme gen
```
Available Commands
- generate/gen Generates README.md file for your project with default configuration
- --help You can get more info about package's usage with this command
Features
This package can help you to generate basic README for your Nest.js project by extracting information from your project such as
- Title and description
- Commands
- Environment variables
- Controllers
### Title and Description
This package will look for title and description in package.json, otherwise it will add basic info.
### Commands
This package will look for basic commands used in Nest.js projects, like "start" and "test" in your package.json's scripts section and if they are present, it will add them.
### Environment variables
The following files ".env", '.env.production' and '.env.development' will be scanned for environment variables and if there are any variables, they will be added as well.The environment variables are expected to be in this format VARIABLE_NAME="value".
### Controllers
This is Nest.js specific feature.If your project has Nest.js-like structure and has "./src/" folder, the package will look for controllers in each module and then list them readme with their endpoints with there parameters and paths.Note that GraphQL and other kind of APIs endpoints aren't supported yet.