Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robertoachar/generator-oss-project
:wrench: Yeoman generator for open source projects.
https://github.com/robertoachar/generator-oss-project
appveyor badges circleci coveralls editorconfig eslint jest node prettier travis yeoman yeoman-generator
Last synced: 9 days ago
JSON representation
:wrench: Yeoman generator for open source projects.
- Host: GitHub
- URL: https://github.com/robertoachar/generator-oss-project
- Owner: robertoachar
- License: mit
- Created: 2017-05-19T04:55:08.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-29T03:08:35.000Z (over 5 years ago)
- Last Synced: 2024-10-11T23:19:13.093Z (25 days ago)
- Topics: appveyor, badges, circleci, coveralls, editorconfig, eslint, jest, node, prettier, travis, yeoman, yeoman-generator
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/generator-oss-project
- Size: 87.9 KB
- Stars: 40
- Watchers: 2
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# OSS Project Generator
> Yeoman generator for open source projects.
[![NPM Version][npm-badge]][npm-url]
[![Downloads][npm-downloads-badge]][npm-downloads-url]
[![Travis Status][travis-badge]][travis-url]
[![CircleCI Status][circleci-badge]][circleci-url]
[![AppVeyor Status][appveyor-badge]][appveyor-url]
[![Coveralls Status][coveralls-badge]][coveralls-url]
[![License][license-badge]][license-url]
This generator provides the following features:
- **src** and **test** folder as a starter point to build your project.
- **esm** as a simple, babel-less, bundle-less ECMAScript module loader.
- **EditorConfig** to help you define and maintain consistent coding styles between different editors.
- **ESLint** to provide a pluggable linting utility for JavaScript.
- **Prettier** as an opinionated code formatter.
- **Jest** as a complete and easy to set-up JavaScript testing solution used by Facebook.
- **Travis** and **CircleCI** as a continuous integration and delivery platform.
- **Appveyor** as a continuous delivery service for Windows.
- **Coveralls** to help you track your code coverage over time, and ensure that all your new code is fully covered.
- **README.md** and **CHANGELOG.md** with information about the project, installation, usage, development, author and license.
- **Badges** for Travis, Appveyor, CircleCI, Coveralls, npm and License.
## Project files
```text
.
|--- 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
```
## Installation
- Install Yeoman
```bash
$ npm install -g yo
```
- Install Generator
```bash
$ npm install -g generator-oss-project
```
## Usage
- Creating a project
```bash
# Create a directory for your project
$ mkdir awesome-project
# Change into directory
$ cd awesome-project
# Generate a project
$ yo oss-project
```
- Running 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` |
## Development
### Prerequisites
- Install [Node.js](https://nodejs.org)
- Install [npm](https://www.npmjs.com/)
- Install Yeoman CLI
```bash
$ npm install -g yo
```
### Clone the repo
```bash
$ git clone https://github.com/robertoachar/generator-oss-project.git
```
### Run generator
```bash
# Change into directory
$ cd generator-oss-project
# Link generator
$ npm link
# Run generator
$ yo oss-project
```
## Author
[Roberto Achar](https://twitter.com/robertoachar)
## Contributors
[Paulo Rezende](https://twitter.com/pauloedurezende)
## License
[MIT](https://github.com/robertoachar/generator-oss-project/blob/master/LICENSE)
[npm-badge]: https://img.shields.io/npm/v/generator-oss-project.svg
[npm-url]: https://www.npmjs.com/package/generator-oss-project
[npm-downloads-badge]: https://img.shields.io/npm/dt/generator-oss-project.svg
[npm-downloads-url]: https://www.npmjs.com/package/generator-oss-project
[travis-badge]: https://travis-ci.org/robertoachar/generator-oss-project.svg?branch=master
[travis-url]: https://travis-ci.org/robertoachar/generator-oss-project
[circleci-badge]: https://circleci.com/gh/robertoachar/generator-oss-project/tree/master.svg?style=shield
[circleci-url]: https://circleci.com/gh/robertoachar/generator-oss-project
[appveyor-badge]: https://ci.appveyor.com/api/projects/status/github/robertoachar/generator-oss-project?branch=master&svg=true
[appveyor-url]: https://ci.appveyor.com/project/robertoachar/generator-oss-project
[coveralls-badge]: https://coveralls.io/repos/github/robertoachar/generator-oss-project/badge.svg?branch=master
[coveralls-url]: https://coveralls.io/github/robertoachar/generator-oss-project?branch=master
[license-badge]: https://img.shields.io/github/license/robertoachar/generator-oss-project.svg
[license-url]: https://opensource.org/licenses/MIT