📦

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