Yeoman generator for open source projects.
MIT License
Yeoman generator for open source projects.
This generator provides the following features:
.
|--- src
| |--- index.js
|--- test
| |--- test.js
|--- .editorconfig
|--- .eslintignore
|--- .eslintrc.json
|--- .gitattributes
|--- .gitignore
|--- .npmrc
|--- .prettierrc
|--- .travis.yml
|--- appveyor.yml
|--- CHANGELOG.md
|--- circle.yml
|--- LICENSE
|--- main.js
|--- package.json
|--- README.md
$ npm install -g yo
$ npm install -g generator-oss-project
# Create a directory for your project
$ mkdir awesome-project
# Change into directory
$ cd awesome-project
# Generate a project
$ yo oss-project
Action | Usage |
---|---|
Starting development mode | npm start |
Linting code | npm run lint |
Running unit tests | npm run jest |
Running lint + tests | npm test |
Running code coverage | npm run coverage |
Sending coverage results to Coveralls.io | npm run coveralls |
$ npm install -g yo
$ git clone https://github.com/robertoachar/generator-oss-project.git
# Change into directory
$ cd generator-oss-project
# Link generator
$ npm link
# Run generator
$ yo oss-project