{"id":21667234,"url":"https://github.com/luftywiranda13/generator-bunny","last_synced_at":"2025-04-12T01:32:24.455Z","repository":{"id":57246668,"uuid":"90593573","full_name":"luftywiranda13/generator-bunny","owner":"luftywiranda13","description":"🐰  Jumpstart node module, like a bunny!","archived":false,"fork":false,"pushed_at":"2018-01-21T23:45:57.000Z","size":1009,"stargazers_count":13,"open_issues_count":5,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T21:12:28.589Z","etag":null,"topics":["automatic","boilerplate","bunny","eslint","intermediate","javascript","node","nodejs","npm","open-source","prettier","semantic-release","starter-kit","yeoman-generator"],"latest_commit_sha":null,"homepage":"","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/luftywiranda13.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":"contributing.md","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-08T06:25:41.000Z","updated_at":"2019-09-11T14:02:08.000Z","dependencies_parsed_at":"2022-08-24T16:10:57.877Z","dependency_job_id":null,"html_url":"https://github.com/luftywiranda13/generator-bunny","commit_stats":null,"previous_names":[],"tags_count":76,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luftywiranda13%2Fgenerator-bunny","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luftywiranda13%2Fgenerator-bunny/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luftywiranda13%2Fgenerator-bunny/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/luftywiranda13%2Fgenerator-bunny/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/luftywiranda13","download_url":"https://codeload.github.com/luftywiranda13/generator-bunny/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247872243,"owners_count":21010204,"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":["automatic","boilerplate","bunny","eslint","intermediate","javascript","node","nodejs","npm","open-source","prettier","semantic-release","starter-kit","yeoman-generator"],"created_at":"2024-11-25T11:35:29.062Z","updated_at":"2025-04-12T01:32:24.424Z","avatar_url":"https://github.com/luftywiranda13.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://cdn.shopify.com/s/files/1/0185/5092/products/nature-0006_large.png\" width=\"184\" alt=\"generator-bunny\" /\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003e\n    Jumpstart \u003ca href=\"https://nodejs.org/api/modules.html#modules_modules\"\u003enode module\u003c/a\u003e, like a bunny!\n  \u003c/strong\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  Scaffold \u003ca href=\"https://www.npmjs.com/\"\u003enode module\u003c/a\u003e or \u003ca href=\"https://en.wikipedia.org/wiki/Open-source_software\"\u003eopen-source\u003c/a\u003e project without having to deal with complicated setup.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/generator-bunny\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/generator-bunny.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://npm-stat.com/charts.html?package=generator-bunny\u0026from=2016-04-01\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/dt/generator-bunny.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://travis-ci.org/luftywiranda13/generator-bunny\"\u003e\n    \u003cimg src=\"https://img.shields.io/travis/luftywiranda13/generator-bunny/master.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://codecov.io/github/luftywiranda13/generator-bunny\"\u003e\n    \u003cimg src=\"https://img.shields.io/codecov/c/github/luftywiranda13/generator-bunny.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003cbr /\u003e\n  \u003ca href=\"http://commitizen.github.io/cz-cli\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/luftywiranda13/generator-bunny/blob/master/other/code-of-conduct.md\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/luftywiranda13/generator-bunny/blob/master/other/roadmap.md\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/%F0%9F%93%94-roadmap-CD9523.svg?style=flat-square\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Why?\n\nThis generator includes built-in modern tools which have been widely used by the community:\n-   [Automated GitHub release notes generator](/releases)\n-   [Automated releasing with semantic-release][semantic-link]\n-   [Automated testing \u0026 validation before any commits][husky-link]\n-   [Automated source-code formatting with prettier][prettier-link]\n-   [Babel transpiler for writing next generation JavaScript][babel-link]\n-   [Eslint linting utility][eslint-link]\n-   [Flow static typechecker][flow-link]\n-   [GitHub templates (Issue \u0026 Pull Request, License, CoC, etc.)](https://github.com/blog/2111-issue-and-pull-request-templates)\n-   [Jest testing framework][jest-link]\n-   [Travis Continuous Integration config][travis-link]\n\n![](screenshot.png)\n\n## Getting started\n\n### 1. Installation\n\n```sh\nnpm install -g yo generator-bunny\n```\n\n### 2. Create new project\n\n**Make a new directory:**\n\n```sh\nmkdir my-bunny\ncd my-bunny\n```\n\n**Generate files:**\n\n```sh\nyo bunny\n```\n\n**Validate project:**\n\n```sh\nnpm start validate\n```\n\n## Usage\n\n### 1. First-timer\n\n**Install and setup [semantic-release][semantic-link]:**\n\n```sh\nnpm install -g semantic-release-cli\n```\n\n\u003e **Note:** Make sure you‘ve set your repository up on GitHub before proceeding otherwise `semantic-release` installation will throw errors!\n\n**Then run:**\n\n```sh\nsemantic-release-cli setup\n```\n\n**Select Travis CI, answer `no` to `overwrite`**\n\n\u003e There‘s already a general purpose [Travis CI][travis-link] configuration stored in [`.travis.yml`](./app/templates/_travis.yml). You can just leave it like that because it‘s already more than enough in most common situation.\n\n### 2. Recommended workflow\n\n**Make some changes. If you want to commit, run (instead of `git commit`):**\n\n```sh\nnpm start commit\n```\n\n**Select the type of commit**\n\n\u003e This project follows the [AngularJS Commit Message Conventions][angular-conventions-link]. Following a standardized commit message format is important if you want to start a maintainable and scalable project. Also it is required to generate changelog and make automated releasing works.\n\n**Push those changes to GitHub**\n\n```sh\ngit push origin master\n```\n\n\u003e **Note:** Don‘t add tag, publish, or bump your project version manually. Let `semantic-release` do those tasks for you. Your release version number is auto-formatted based on [SemVer specifications][semver-link].\n\n\n### 3. Your own workflow\n\n\u003e You don‘t have to follow those recommended steps. Define your own workflow if you will but one of the consequence is you don‘t get the ability to publish/release your package to [npm][npm-link] automatically.\n\nFor example, you still can do it like this:\n\n```sh\ngit add .\ngit commit -m \"I want to do it my way cause this is my project and I‘m working for myself\"\n```\n\n## Tips\n\n\u003e Some useful scripts are provided by [nps](https://github.com/kentcdodds/nps) to help you maintain your project.\n\nTo see the list, run:\n\n```sh\nnpm start\n```\n\n## FAQ\n\n#### 1. Why does `generator-bunny` use `npm` to install dependencies?\n\n\u003e We did support auto-detect \u0026 auto-install dependencies using `yarn` before but then decided to drop that feature in v4 because `yarn` is buggy and `npm` has a lot more users than `yarn`.\n\n#### 2. Why does `generator-bunny` remove lockfiles in pre-commit?\n\n\u003e Lockfiles are for apps, not for packages/libraries. Read more on [What do you think of lockfiles?](https://github.com/sindresorhus/ama/issues/479#issuecomment-310661514)\n\n## Inspiration\n\n- [Sindre Sorhus](https://github.com/sindresorhus) ⟷ [generator-nm](https://github.com/sindresorhus/generator-nm)\n- [Kent C. Dodds](https://github.com/kentcdodds) ⟷ [generator-kcd-oss](https://github.com/kentcdodds/generator-kcd-oss)\n\n## Contributors\n\nThanks goes to these people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n| [\u003cimg src=\"https://avatars3.githubusercontent.com/u/22868432?v=3\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003eLufty Wiranda\u003c/sub\u003e](http://instagram.com/luftywiranda13)\u003cbr /\u003e[💻](https://github.com/luftywiranda13/generator-bunny/commits?author=luftywiranda13 \"Code\") [📖](https://github.com/luftywiranda13/generator-bunny/commits?author=luftywiranda13 \"Documentation\") [🚇](#infra-luftywiranda13 \"Infrastructure (Hosting, Build-Tools, etc)\") |\n| :---: |\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!\n\n## License\nMIT \u0026copy; [Lufty Wiranda](https://www.instagram.com/luftywiranda13)\n\n\u003c!-- reference --\u003e\n[angular-conventions-link]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit\n[babel-link]: https://babeljs.io\n[eslint-link]: http://eslint.org/\n[flow-link]: https://flow.org\n[husky-link]: https://github.com/typicode/husky\n[jest-link]: https://facebook.github.io/jest\n[npm-link]: https://www.npmjs.com/\n[prettier-link]: https://github.com/prettier/prettier\n[roadmap-link]: https://github.com/luftywiranda13/generator-bunny/blob/master/other/roadmap.md\n[semantic-link]: https://github.com/semantic-release/semantic-release\n[semver-link]: http://semver.org/\n[travis-link]: https://travis-ci.org\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluftywiranda13%2Fgenerator-bunny","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluftywiranda13%2Fgenerator-bunny","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluftywiranda13%2Fgenerator-bunny/lists"}