{"id":19691534,"url":"https://github.com/99x/react-scaffolder","last_synced_at":"2025-10-11T15:06:54.813Z","repository":{"id":57093850,"uuid":"66241977","full_name":"99x/react-scaffolder","owner":"99x","description":":zap: Scaffolding tool for React","archived":false,"fork":false,"pushed_at":"2019-04-28T05:07:57.000Z","size":203,"stargazers_count":43,"open_issues_count":15,"forks_count":14,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-13T08:02:28.303Z","etag":null,"topics":["cli","hacktoberfest","javascript","nodejs","react","react-components","scaffold","scaffolding"],"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/99x.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-22T05:25:01.000Z","updated_at":"2025-01-04T02:37:03.000Z","dependencies_parsed_at":"2022-08-22T21:40:33.851Z","dependency_job_id":null,"html_url":"https://github.com/99x/react-scaffolder","commit_stats":null,"previous_names":["99xt/react-scaffolder","99xt/react-cli"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/99x%2Freact-scaffolder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/99x%2Freact-scaffolder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/99x%2Freact-scaffolder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/99x%2Freact-scaffolder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/99x","download_url":"https://codeload.github.com/99x/react-scaffolder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251473216,"owners_count":21595024,"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":["cli","hacktoberfest","javascript","nodejs","react","react-components","scaffold","scaffolding"],"created_at":"2024-11-11T19:09:39.661Z","updated_at":"2025-10-11T15:06:49.763Z","avatar_url":"https://github.com/99x.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![logo](https://user-images.githubusercontent.com/7692626/29966125-1d9e5ba6-8f2e-11e7-9155-c6cdc3c61be2.png)\n\n\n\n# react-scaffolder ![Dependency status](https://david-dm.org/99xt/react-cli.svg) [![Build Status](https://travis-ci.org/99xt/react-scaffolder.svg?branch=master)](https://travis-ci.org/99xt/react-scaffolder)\n\n[![Join the chat at https://gitter.im/react-scaffolder/Lobby](https://badges.gitter.im/react-scaffolder/Lobby.svg)](https://gitter.im/react-scaffolder/Lobby?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\nScaffolding tool for [React](https://facebook.github.io/react/)\n\nreact-scaffolder is a command line interface which brings smooth developer experience (DX) for React devs. react-scaffolder provides a better way to generate react projects with [react-boilerplate](https://github.com/99xt/react-boilerplate). With this tool it's possible to continue generating boilerplate code with heavy customizations once a project is initiated.\n\n## Install\n\n```\n$ npm install -g react-scaffolder\n```\n\nor if you're using [yarn](https://yarnpkg.com),\n\n```\n$ yarn global add react-scaffolder\n```\n\n## Quick Start\n\nQuickest way to get up and running with react-scaffolder\n\n- Install the CLI - ```$ npm install -g react-scaffolder```\n\n- Initiate a project - ```$ react init awesome-project \u0026\u0026 cd awesome-project```\n- Install dependencies - ```$ npm install```\n- Run the build - ```$ npm run build \u0026\u0026 npm start```\n- Instantly create React components - ```$ react g component feed footer```\n- Check with interactive view - ```$ react v -c```\n\n## Usage\n\n### react init [name] [git repository URL]\n*alias: i*\n\n#### name\n\nProject name.\n\n#### Git repository URL (optional)\n\nGit repository URL that you need to use as the template.\n\n#### Options\n\n* `-l`\nAdd eslint configuration.\n\n---------------------------------------\n\n### react generate component [module] [component]\n*alias: g*\n\n#### module\n\nModule name where the react component should be placed within. (Subdirectory within components directory)\n\n#### component\n\nReact component name.\nIf you leave that empty generator creates folder with module name, and index.js inside\n\n#### Options\n\n* `-f` Generate only file and use module as filename\n\n#### Define propNames\nAt \"Prop names\" question you can use \"*\" to mark as required `title*` and also you can define type `title:string` and sure you can write `title:string*`\nIf you didn't define a type cli will ask you to choose it from the list.\n\n---------------------------------------\n\n### react generate test [module] [component]\n*alias: g*\n\nCreate React component.\n\n#### module\n\nModule name where the test file should be placed within. (Subdirectory within __tests__ directory)\n\n#### component\n\nTest file name.\n\n---------------------------------------\n\n### react view -c -t\n*alias: v*\n\nView react components and test files.\n\n#### Options\n\n* `-c`\nView React components file directory.\n\n* `-t`\nView tests file directory.\n\n### react config [key] [value]\n*alias: c*\n\nChange configuration in `.reactclirc`.\n\n#### key\n\nKey for configuration\nexample: `client`\n\n#### value\n\nValue for configuration\nexample: `src` (source directory)\n\n---------------------------------------\n\n## Configuring existing projects\n\nTo use react-cli in existing React project navigate to directory where React components are created.\nCreate react-cli configuration file, `.reactclirc` (similar to `.babelrc`). Add configuration in key value pairs.\n\n```\n{\n\t\"client\": \"src\"\n}\n```\n\nThis specifies that React components are placed in `src/components` directory.\n\n---------------------------------------\n\n## Features\n\n- Initiate React projects\n- Create React components\n- Create test files\n- Interactive view of the component structure\n\n#### [Future work](https://github.com/99xt/react-scaffolder/issues/23)\n\n## References\n\n- [What is scaffolding ?](https://en.wikipedia.org/wiki/Scaffold_(programming))\n- [What is a CLI ?](https://www.techopedia.com/definition/3337/command-line-interface-cli)\n- [Why good UX in CLIs matters](https://trevorsullivan.net/2016/07/11/designing-command-line-tools/)\n- Projects which facilitate similar objectives\n  - [Yeoman](http://yeoman.io/)\n\n## Contributor guidelines\n\n- Fork the repository.\n- Clone the forked repository.\n- Create your own branch.\n- Create tests and make sure tests pass on travis.\n- Create a pull request with changes made.\n\nFor more information refer [CONTRIBUTING.md](https://github.com/99xt/react-cli/blob/master/CONTRIBUTING.md)\n\n## License\n\nMIT © [99XT](https://github.com/99xt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F99x%2Freact-scaffolder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F99x%2Freact-scaffolder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F99x%2Freact-scaffolder/lists"}