https://github.com/kentcdodds/generator-kcd-oss
A yeoman generator for my open source modules
https://github.com/kentcdodds/generator-kcd-oss
Last synced: over 1 year ago
JSON representation
A yeoman generator for my open source modules
- Host: GitHub
- URL: https://github.com/kentcdodds/generator-kcd-oss
- Owner: kentcdodds
- License: mit
- Created: 2016-05-01T05:28:34.000Z (about 10 years ago)
- Default Branch: main
- Last Pushed: 2023-04-26T02:31:26.000Z (about 3 years ago)
- Last Synced: 2025-03-31T00:32:34.540Z (over 1 year ago)
- Language: JavaScript
- Homepage: http://yeoman.io/
- Size: 371 KB
- Stars: 137
- Watchers: 6
- Forks: 28
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
generator-kcd-oss
An open source project generator for my open source projects :)
---
[![Build Status][build-badge]][build]
[![version][version-badge]][package]
[![downloads][downloads-badge]][npmtrends]
[![MIT License][license-badge]][license]
[![All Contributors][all-contributors-badge]](#contributors-)
[![PRs Welcome][prs-badge]][prs]
[![Code of Conduct][coc-badge]][coc]
## The problem
I have to do a lot of repetitive stuff every time I set up a new open source
project.
## This solution
This is a yeoman generator for my open source projects
## Table of Contents
- [Installation](#installation)
- [Try Without Installing](#try-without-installing)
- [Usage](#usage)
- [Inspiration](#inspiration)
- [Issues](#issues)
- [🐛 Bugs](#-bugs)
- [💡 Feature Requests](#-feature-requests)
- [Contributors ✨](#contributors-)
- [LICENSE](#license)
## Installation
This module is distributed via [npm][npm] which is bundled with [node][node] and
should be installed globally (with `yo`):
```sh
npm install -g generator-kcd-oss yo
```
### Try Without Installing
```sh
npx -p yo -p generator-kcd-oss -c 'yo kcd-oss'
```
## Usage
```sh
yo kcd-oss
```
Follow the prompts...
## Inspiration
I referenced [@sindresorhus][sindresorhus]'s [module][generator-nm] heavily.
## Issues
_Looking to contribute? Look for the [Good First Issue][good-first-issue]
label._
### 🐛 Bugs
Please file an issue for bugs, missing documentation, or unexpected behavior.
[**See Bugs**][bugs]
### 💡 Feature Requests
Please file an issue to suggest new features. Vote on feature requests by adding
a 👍. This helps maintainers prioritize what to work on.
[**See Feature Requests**][requests]
## Contributors ✨
Thanks goes to these people ([emoji key][emojis]):
Kent C. Dodds
💻 📖 🚇
Anup
📖
Eric McCormick
📖
Michaël De Boey
💻 📖
Matan Borenkraout
💻
Nick McCurdy
📖 💻
This project follows the [all-contributors][all-contributors] specification.
Contributions of any kind welcome!
## LICENSE
MIT
[npm]: https://www.npmjs.com
[node]: https://nodejs.org
[build-badge]: https://img.shields.io/github/workflow/status/kentcdodds/generator-kcd-oss/validate?logo=github&style=flat-square
[build]: https://github.com/kentcdodds/generator-kcd-oss/actions?query=workflow%3Avalidate
[version-badge]: https://img.shields.io/npm/v/generator-kcd-oss.svg?style=flat-square
[package]: https://www.npmjs.com/package/generator-kcd-oss
[downloads-badge]: https://img.shields.io/npm/dm/generator-kcd-oss.svg?style=flat-square
[npmtrends]: https://www.npmtrends.com/generator-kcd-oss
[license-badge]: https://img.shields.io/npm/l/generator-kcd-oss.svg?style=flat-square
[license]: https://github.com/kentcdodds/generator-kcd-oss/blob/master/LICENSE
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
[prs]: https://makeapullrequest.com
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]: https://github.com/kentcdodds/generator-kcd-oss/blob/master/CODE_OF_CONDUCT.md
[emojis]: https://github.com/all-contributors/all-contributors#emoji-key
[all-contributors]: https://github.com/all-contributors/all-contributors
[all-contributors-badge]: https://img.shields.io/github/all-contributors/kentcdodds/generator-kcd-oss?color=orange&style=flat-square
[bugs]: https://github.com/kentcdodds/generator-kcd-oss/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Acreated-desc+label%3Abug
[requests]: https://github.com/kentcdodds/generator-kcd-oss/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement
[good-first-issue]: https://github.com/kentcdodds/generator-kcd-oss/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3Aenhancement+label%3A%22good+first+issue%22
[sindresorhus]: https://github.com/sindresorhus
[generator-nm]: https://github.com/sindresorhus/generator-nm