{"id":16330380,"url":"https://github.com/robertoachar/generator-oss-project","last_synced_at":"2025-03-20T22:32:14.935Z","repository":{"id":57248287,"uuid":"91766925","full_name":"robertoachar/generator-oss-project","owner":"robertoachar","description":":wrench: Yeoman generator for open source projects.","archived":false,"fork":false,"pushed_at":"2019-07-29T03:08:35.000Z","size":90,"stargazers_count":40,"open_issues_count":0,"forks_count":11,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-28T08:31:44.769Z","etag":null,"topics":["appveyor","badges","circleci","coveralls","editorconfig","eslint","jest","node","prettier","travis","yeoman","yeoman-generator"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/generator-oss-project","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robertoachar.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-19T04:55:08.000Z","updated_at":"2024-07-10T17:14:10.000Z","dependencies_parsed_at":"2022-08-24T16:11:09.573Z","dependency_job_id":null,"html_url":"https://github.com/robertoachar/generator-oss-project","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertoachar%2Fgenerator-oss-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertoachar%2Fgenerator-oss-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertoachar%2Fgenerator-oss-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertoachar%2Fgenerator-oss-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robertoachar","download_url":"https://codeload.github.com/robertoachar/generator-oss-project/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244088325,"owners_count":20396110,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appveyor","badges","circleci","coveralls","editorconfig","eslint","jest","node","prettier","travis","yeoman","yeoman-generator"],"created_at":"2024-10-10T23:19:07.748Z","updated_at":"2025-03-20T22:32:14.609Z","avatar_url":"https://github.com/robertoachar.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# OSS Project Generator\n\n\u003e Yeoman generator for open source projects.\n\n[![NPM Version][npm-badge]][npm-url]\n[![Downloads][npm-downloads-badge]][npm-downloads-url]\n[![Travis Status][travis-badge]][travis-url]\n[![CircleCI Status][circleci-badge]][circleci-url]\n[![AppVeyor Status][appveyor-badge]][appveyor-url]\n[![Coveralls Status][coveralls-badge]][coveralls-url]\n[![License][license-badge]][license-url]\n\nThis generator provides the following features:\n\n- **src** and **test** folder as a starter point to build your project.\n- **esm** as a simple, babel-less, bundle-less ECMAScript module loader.\n- **EditorConfig** to help you define and maintain consistent coding styles between different editors.\n- **ESLint** to provide a pluggable linting utility for JavaScript.\n- **Prettier** as an opinionated code formatter.\n- **Jest** as a complete and easy to set-up JavaScript testing solution used by Facebook.\n- **Travis** and **CircleCI** as a continuous integration and delivery platform.\n- **Appveyor** as a continuous delivery service for Windows.\n- **Coveralls** to help you track your code coverage over time, and ensure that all your new code is fully covered.\n- **README.md** and **CHANGELOG.md** with information about the project, installation, usage, development, author and license.\n- **Badges** for Travis, Appveyor, CircleCI, Coveralls, npm and License.\n\n## Project files\n\n```text\n.\n|--- src\n|    |--- index.js\n|--- test\n|    |--- test.js\n|--- .editorconfig\n|--- .eslintignore\n|--- .eslintrc.json\n|--- .gitattributes\n|--- .gitignore\n|--- .npmrc\n|--- .prettierrc\n|--- .travis.yml\n|--- appveyor.yml\n|--- CHANGELOG.md\n|--- circle.yml\n|--- LICENSE\n|--- main.js\n|--- package.json\n|--- README.md\n```\n\n## Installation\n\n- Install Yeoman\n\n```bash\n$ npm install -g yo\n```\n\n- Install Generator\n\n```bash\n$ npm install -g generator-oss-project\n```\n\n## Usage\n\n- Creating a project\n\n```bash\n# Create a directory for your project\n$ mkdir awesome-project\n\n# Change into directory\n$ cd awesome-project\n\n# Generate a project\n$ yo oss-project\n```\n\n- Running project\n\n| Action                                   | Usage               |\n| ---------------------------------------- | ------------------- |\n| Starting development mode                | `npm start`         |\n| Linting code                             | `npm run lint`      |\n| Running unit tests                       | `npm run jest`      |\n| Running lint + tests                     | `npm test`          |\n| Running code coverage                    | `npm run coverage`  |\n| Sending coverage results to Coveralls.io | `npm run coveralls` |\n\n## Development\n\n### Prerequisites\n\n- Install [Node.js](https://nodejs.org)\n- Install [npm](https://www.npmjs.com/)\n- Install Yeoman CLI\n\n```bash\n$ npm install -g yo\n```\n\n### Clone the repo\n\n```bash\n$ git clone https://github.com/robertoachar/generator-oss-project.git\n```\n\n### Run generator\n\n```bash\n# Change into directory\n$ cd generator-oss-project\n\n# Link generator\n$ npm link\n\n# Run generator\n$ yo oss-project\n```\n\n## Author\n\n[Roberto Achar](https://twitter.com/robertoachar)\n\n## Contributors\n\n[Paulo Rezende](https://twitter.com/pauloedurezende)\n\n## License\n\n[MIT](https://github.com/robertoachar/generator-oss-project/blob/master/LICENSE)\n\n[npm-badge]: https://img.shields.io/npm/v/generator-oss-project.svg\n[npm-url]: https://www.npmjs.com/package/generator-oss-project\n[npm-downloads-badge]: https://img.shields.io/npm/dt/generator-oss-project.svg\n[npm-downloads-url]: https://www.npmjs.com/package/generator-oss-project\n[travis-badge]: https://travis-ci.org/robertoachar/generator-oss-project.svg?branch=master\n[travis-url]: https://travis-ci.org/robertoachar/generator-oss-project\n[circleci-badge]: https://circleci.com/gh/robertoachar/generator-oss-project/tree/master.svg?style=shield\n[circleci-url]: https://circleci.com/gh/robertoachar/generator-oss-project\n[appveyor-badge]: https://ci.appveyor.com/api/projects/status/github/robertoachar/generator-oss-project?branch=master\u0026svg=true\n[appveyor-url]: https://ci.appveyor.com/project/robertoachar/generator-oss-project\n[coveralls-badge]: https://coveralls.io/repos/github/robertoachar/generator-oss-project/badge.svg?branch=master\n[coveralls-url]: https://coveralls.io/github/robertoachar/generator-oss-project?branch=master\n[license-badge]: https://img.shields.io/github/license/robertoachar/generator-oss-project.svg\n[license-url]: https://opensource.org/licenses/MIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertoachar%2Fgenerator-oss-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobertoachar%2Fgenerator-oss-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertoachar%2Fgenerator-oss-project/lists"}