https://github.com/mattphillips/oss-box

Open source project boilerplate generator 📦
https://github.com/mattphillips/oss-box

boilerplate generator open-source oss

Last synced: 3 months ago
JSON representation

Open source project boilerplate generator 📦

• Host: GitHub
• URL: https://github.com/mattphillips/oss-box
• Owner: mattphillips
• License: mit
• Created: 2017-10-17T21:36:40.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-13T20:09:57.000Z (over 7 years ago)
• Last Synced: 2025-04-13T06:13:12.597Z (3 months ago)
• Topics: boilerplate, generator, open-source, oss
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/oss-box
• Size: 109 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


oss-box


📦

Open source project boilerplate generator





[![Build Status](https://img.shields.io/travis/mattphillips/oss-box.svg?style=flat-square)](https://travis-ci.org/mattphillips/oss-box)

[![Code Coverage](https://img.shields.io/codecov/c/github/mattphillips/oss-box.svg?style=flat-square)](https://codecov.io/github/mattphillips/oss-box)

[![version](https://img.shields.io/npm/v/oss-box.svg?style=flat-square)](https://www.npmjs.com/package/oss-box)

[![downloads](https://img.shields.io/npm/dm/oss-box.svg?style=flat-square)](http://npm-stat.com/charts.html?package=oss-box&from=2017-09-14)

[![MIT License](https://img.shields.io/npm/l/oss-box.svg?style=flat-square)](https://github.com/mattphillips/oss-box/blob/master/LICENSE)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)

[![Roadmap](https://img.shields.io/badge/%F0%9F%93%94-roadmap-CD9523.svg?style=flat-square)](https://github.com/mattphillips/oss-box/blob/master/docs/ROADMAP.md)

[![Examples](https://img.shields.io/badge/%F0%9F%92%A1-examples-ff615b.svg?style=flat-square)](https://github.com/mattphillips/oss-box/blob/master/docs/EXAMPLES.md)

## 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:

```sh

npm install -g oss-box

```

With yarn:

```sh

yarn global add oss-box

```

## Usage

Run the following and answer the prompts

```bash

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](https://travis-ci.org/) is the default continuous integration provider

 - Code coverage: [Codecov](https://codecov.io/) is the default code coverage provider

 - License: [MIT](https://opensource.org/licenses/MIT)

 - Contributors: [all-contributors](https://github.com/kentcdodds/all-contributors) specification is configured to

 acknowledge contributors to the project from everyone

## Other solutions

This package is inspired by [@kentcdodds](https://github.com/kentcdodds)'s [generator-kcd-oss](https://github.com/kentcdodds/generator-kcd-oss) project

## Contributors

| [
Matt Phillips](http://mattphillips.io)
[💻](https://github.com/mattphillips/oss-box/commits?author=mattphillips "Code") [📖](https://github.com/mattphillips/oss-box/commits?author=mattphillips "Documentation") [🚇](#infra-mattphillips "Infrastructure (Hosting, Build-Tools, etc)") |

| :---: |

## LICENSE

MIT