Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nanogiants/nano-nodegen
This package contains a yeoman generator for scaffolding node apps
https://github.com/nanogiants/nano-nodegen
Last synced: 8 days ago
JSON representation
This package contains a yeoman generator for scaffolding node apps
- Host: GitHub
- URL: https://github.com/nanogiants/nano-nodegen
- Owner: nanogiants
- License: mit
- Created: 2020-07-06T13:01:59.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-18T10:37:11.000Z (about 3 years ago)
- Last Synced: 2024-10-12T23:15:06.486Z (about 1 month ago)
- Language: TypeScript
- Size: 365 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# nano-nodegen
This package contains a yeoman generator for scaffolding node apps with typescript support.
## Usage
```bash
npm i -g yo
npm i -g @nanogiants/generator-nano-nodegen
yo @nanogiants/nano-nodegen
```
These commands will prompt you with some questions from which your project gets bootstrapped.
## Features
### Filetree when selecting all options
```bash
├── .eslintrc.js # eslint config
├── .gitignore # files ignored by git
├── .prettierrc.js # prettier config
├── LICENSE.md
├── CHANGELOG.md
├── README.md
├── docker-compose.yml # compose file for sonarqube and postgress containers
├── jest.config.js # config for your jest testing library
├── nodemon.json # config for your filewatcher
├── package-lock.json
├── package.json # your projects package setup
├── scripts
│ └── report_sonarqube.sh # helper script to report to sonarqube
├── sonar-project.properties # sonarqube configuration file
├── src
│ ├── index.ts # your apps entry point
│ └── lib # your apps logic
│ ├── hello.spec.ts # a sample test file
│ └── hello.ts # a sample ts file
└── tsconfig.json # the typescript configuration file
```
### Eslint
Enables linting with predefined config.
See more at [eslint](https://www.npmjs.com/package/eslint).
#### Husky and Lint-Staged
If eslint gets selected you will also be asked if you want to install commit hooks with [husky](https://www.npmjs.com/package/husky) and lint your files while staging with [lint-staged](https://www.npmjs.com/package/lint-staged).
### Prettier
Enables codeformatting with [prettier](https://www.npmjs.com/package/prettier).
### Jest
Enables testing your code with [jest](https://jestjs.io/).
To test your files run
```bash
npm run test
```
or
```
npm run test:cov # also creates coverage file to report to sonarqube
```
#### Sonarqube
If jest gets selected you will also be asked if you want to configure [sonarqube](https://www.sonarqube.org/). If `yes` your project will setup a `docker-compose.yml` file and a few scripts to get started.
To start sonarqube run
```bash
npm run sonarqube:start
```
To stop sonarqube run
```bash
npm run sonarqube:stop
```
To report your testcoverage just run
```bash
npm run sonarqube:report YOUR_KEY
```
or
```bash
sh ./scripts/report_sonarqube.sh -k YOUR_KEY
```
#### Changelog
If Changelog gets selected you can create a changelog with angular commit guidelines when you update your npm version.
Initially you need to call
```bash
npm run init-changelog
```
once, to create the initial changelog file.
It then gets updated everytime you update your version.
## Contributing
To contribute please fork the repository, create a new branch to make changes on and create a pull request into the develop branch of this repository.
Remember to write tests (if needed) to get the features approved.
## Feature Requests
For feature requests please use the issuetracker and specify your exact needs.
## License
[MIT](https://github.com/nanogiants/nano-nodegen/blob/master/LICENSE.md)
## Changelog
[CHANGELOG](https://github.com/nanogiants/nano-nodegen/blob/master/CHANGELOG.md)
## Test Coverage
[On Github Pages](https://nanogiants.github.io/nano-nodegen/)