{"id":16330402,"url":"https://github.com/robertoachar/generator-node","last_synced_at":"2025-03-22T22:31:41.713Z","repository":{"id":45872762,"uuid":"114573103","full_name":"robertoachar/generator-node","owner":"robertoachar","description":":wrench: Yeoman generator for Node projects.","archived":false,"fork":false,"pushed_at":"2021-11-30T20:08:42.000Z","size":299,"stargazers_count":17,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-18T05:52:25.916Z","etag":null,"topics":["babel","badges","editorconfig","eslint","jest","node","npm","ntl","prettier","yeoman","yeoman-generator"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/@robertoachar/generator-node","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-12-17T22:23:57.000Z","updated_at":"2023-06-04T18:38:18.000Z","dependencies_parsed_at":"2022-09-05T05:20:41.993Z","dependency_job_id":null,"html_url":"https://github.com/robertoachar/generator-node","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertoachar%2Fgenerator-node","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertoachar%2Fgenerator-node/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertoachar%2Fgenerator-node/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertoachar%2Fgenerator-node/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robertoachar","download_url":"https://codeload.github.com/robertoachar/generator-node/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245028659,"owners_count":20549556,"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":["babel","badges","editorconfig","eslint","jest","node","npm","ntl","prettier","yeoman","yeoman-generator"],"created_at":"2024-10-10T23:19:10.131Z","updated_at":"2025-03-22T22:31:41.425Z","avatar_url":"https://github.com/robertoachar.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# generator-node\n\n[![Travis Status][travis-badge]][travis-url]\n[![AppVeyor Status][appveyor-badge]][appveyor-url]\n[![CircleCI Status][circleci-badge]][circleci-url]\n[![Coveralls Status][coveralls-badge]][coveralls-url]\n[![NPM Version][npm-badge]][npm-url]\n[![License][license-badge]][license-url]\n\n\u003e Yeoman generator for Node projects.\n\nThis generator provides the following features:\n\n- **src** folder as a starter point to build your project.\n- **esm** as a simple, babel-less, bundle-less ECMAScript module loader.\n- **ESLint** to provide a pluggable linting utility for JavaScript.\n- **Prettier** as an opinionated code formatter.\n- **Jest** as a JavaScript Testing Framework with a focus on simplicity.\n- **jest-runner-eslint** as an ESLint runner for Jest.\n- **ntl** support. Interactive cli to list and run package.json scripts.\n- **EditorConfig** to help you define and maintain consistent coding styles between different editors.\n- **README.md** and **CHANGELOG.md** with information about the project, installation, usage, development, author and license.\n- **Badges** for License.\n\n## Project files\n\n```text\n.\n|--- src\n|    |--- index.js\n|--- .editorconfig\n|--- .eslintignore\n|--- .eslintrc.json\n|--- .gitattributes\n|--- .gitignore\n|--- .npmrc\n|--- babel.config.js\n|--- CHANGELOG.md\n|--- jest-eslint.config.js\n|--- jest-test.config.js\n|--- jest.config.js\n|--- LICENSE\n|--- main.js\n|--- package.json\n|--- README.md\n```\n\n## Installation\n\n- Install Yeoman\n\n```bash\n$ npm i -g yo\n```\n\nor\n\n```bash\n$ yarn global add yo\n```\n\n- Install Generator\n\n```bash\n$ npm i -g @robertoachar/generator-node\n```\n\nor\n\n```bash\n$ yarn global add @robertoachar/generator-node\n```\n\n## Usage\n\n- Create 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 @robertoachar/node\n```\n\n- Run project\n\n| Action                              | Usage (npm)             | Usage (yarn)         |\n| ----------------------------------- | ----------------------- | -------------------- |\n| Start development mode              | `npm start`             | `yarn start`         |\n| Run lint                            | `npm run lint`          | `yarn lint`          |\n| Start lint in watch mode            | `npm run lint:watch`    | `yarn lint:watch`    |\n| Run tests                           | `npm run jest`          | `yarn jest`          |\n| Start tests in watch mode           | `npm run jest:watch`    | `yarn jest:watch`    |\n| Run tests with code coverage        | `npm run jest:coverage` | `yarn jest:coverage` |\n| Run lint + tests                    | `npm test`              | `yarn test`          |\n| Start lint + tests in watch mode    | `npm test:watch`        | `yarn test:watch`    |\n| Run lint + tests with code coverage | `npm test:coverage`     | `yarn test:coverage` |\n\n## Development\n\n### Prerequisites\n\n- Install [Node.js](https://nodejs.org)\n- Install [npm](https://www.npmjs.com/)\n- Install [Yarn](https://yarnpkg.com/)\n- Install Yeoman CLI\n\n```bash\n$ npm i -g add yo\n```\n\nor\n\n```bash\n$ yarn global add yo\n```\n\n### Clone the repo\n\n```bash\n$ git clone https://github.com/robertoachar/generator-node.git\n```\n\n### Run generator\n\n```bash\n# Change into directory\n$ cd generator-node\n\n# Link generator\n$ yarn link # or npm link\n\n# Run generator\n$ yo @robertoachar/node\n```\n\n## Author\n\n[Roberto Achar](https://twitter.com/robertoachar)\n\n## License\n\n[MIT](https://github.com/robertoachar/generator-node/blob/master/LICENSE)\n\n[travis-badge]: https://travis-ci.org/robertoachar/generator-node.svg?branch=master\n[travis-url]: https://travis-ci.org/robertoachar/generator-node\n[appveyor-badge]: https://ci.appveyor.com/api/projects/status/github/robertoachar/generator-node?branch=master\u0026svg=true\n[appveyor-url]: https://ci.appveyor.com/project/robertoachar/generator-node\n[circleci-badge]: https://circleci.com/gh/robertoachar/generator-node/tree/master.svg?style=shield\n[circleci-url]: https://circleci.com/gh/robertoachar/generator-node\n[coveralls-badge]: https://coveralls.io/repos/github/robertoachar/generator-node/badge.svg?branch=master\n[coveralls-url]: https://coveralls.io/github/robertoachar/generator-node?branch=master\n[npm-badge]: https://img.shields.io/npm/v/@robertoachar/generator-node.svg\n[npm-url]: https://www.npmjs.com/package/@robertoachar/generator-node\n[license-badge]: https://img.shields.io/github/license/robertoachar/generator-node.svg\n[license-url]: https://opensource.org/licenses/MIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertoachar%2Fgenerator-node","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobertoachar%2Fgenerator-node","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertoachar%2Fgenerator-node/lists"}