https://github.com/nanogiants/repository-setup
https://github.com/nanogiants/repository-setup
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nanogiants/repository-setup
- Owner: nanogiants
- Created: 2021-10-26T14:01:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-28T07:47:33.000Z (over 3 years ago)
- Last Synced: 2025-02-19T12:56:13.613Z (3 months ago)
- Language: JavaScript
- Size: 71.3 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NanoGiants Repository Setup
This project helps setting up the necessary Open Source related markdown files according to our default CODE_OF_CONDUCT and CONTRIBUTING (guidelines). It also includes generation of LICENSE file, either with our default license (MIT) or any other you want.
## Setup
### Installation
```bash
npm install -g @nanogiants/repository-setup
```
Then run:
```bash
ng-repo-setup
```
### Without installation
Just run this module with npx:
```bash
npx --package=@nanogiants/repository-setup ng-repo-setup
```
Then answer the questions in your console. After the required files have been generated, you may edit the TODO comments in the generated Code of Conduct and Contributing files.
## Templates
The templates are based on the templates of the [`contributing-gen`](https://www.npmjs.com/package/contributing-gen) npm module: https://github.com/bttger/contributing-gen/tree/master/templates