# generator-oss-project > Yeoman generator for open source projects. Latest version **3.0.0** (published 2019-05-07) · MIT license · 0 weekly downloads ## Install ```sh npm install generator-oss-project pnpm add generator-oss-project yarn add generator-oss-project bun add generator-oss-project ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 3.0.0 | | Published | 2019-05-07 | | First published | 2017-05-20 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 21 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 41 | | Author | Roberto Achar | | Maintainers | robertoachar | | Keywords | yeoman, yeoman-generator, node, esm, jest, editorconfig, eslint, prettier, travis, appveyor, circleci, coveralls, badges | ## Links - npm: https://www.npmjs.com/package/generator-oss-project - Repository: https://github.com/robertoachar/generator-oss-project - Homepage: https://github.com/robertoachar/generator-oss-project#readme - Issues: https://github.com/robertoachar/generator-oss-project/issues - npm.io page: https://npm.io/package/generator-oss-project ## Dependencies (2) - [esm](https://npm.io/package/esm.md) 3.2.22 - [yeoman-generator](https://npm.io/package/yeoman-generator.md) 3.2.0 ## Alternatives - [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads - [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads - [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads - [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads - [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads ## Recent versions - 3.0.0 (latest) — 2019-05-07 - 2.3.1 — 2019-01-03 - 2.3.0 — 2018-09-13 - 2.2.1 — 2018-07-23 - 2.2.0 — 2018-07-13 - 2.1.1 — 2018-04-19 - 2.1.0 — 2018-04-19 - 2.0.0 — 2017-12-19 - 1.0.10 — 2017-06-09 - 1.0.9 — 2017-05-30 - 1.0.8 — 2017-05-30 - 1.0.6 — 2017-05-29 - 1.0.5 — 2017-05-29 - 1.0.4 — 2017-05-29 - 1.0.3 — 2017-05-29 - … 3 more at https://npm.io/package/generator-oss-project/versions ## 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 --- _Source: https://npm.io/package/generator-oss-project · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._