0.0.5 ā¢ Published 6 years ago
oss-box v0.0.5
š¦
Open source project boilerplate generator
Problem
Starting a new open source project is a pain to setup all of the boilerplate
Solution
Automate as much of the boilerplate as possible š. oss-box
is an interactive generator of new open source
JavaScript projects.
Installation
With npm:
npm install -g oss-box
With yarn:
yarn global add oss-box
Usage
Run the following and answer the prompts
oss-box my-cool-project
Will generate the following project:
my-cool-project
āāā .all-contributorsrc
āāā .github
āĀ Ā āāā ISSUE_TEMPLATE.md
āĀ Ā āāā PULL_REQUEST_TEMPLATE.md
āāā .gitignore
āāā .travis.yml
āāā CONTRIBUTING.md
āāā LICENSE
āāā README.md
āāā docs
āĀ Ā āāā EXAMPLES.md
āĀ Ā āāā ROADMAP.md
āāā package.json
Defaults
This generator has the following defaults:
- CI: Travis is the default continuous integration provider
- Code coverage: Codecov is the default code coverage provider
- License: MIT
- Contributors: all-contributors specification is configured to acknowledge contributors to the project from everyone
Other solutions
This package is inspired by @kentcdodds's generator-kcd-oss project
Contributors
Matt Phillipsš» š š |
---|
LICENSE
MIT