A light weight interactive CLI Automation Tool 🛠️ for rapid scaffolding of tailored React apps with Create React App under the hood. :atom:
Built with :heart: by Vinay.
About • Features • Requirements • Installation • Documentation • Road Map • Contributing • License
Rapid React is an interactive CLI tool which automates the repetitive steps involved every time a new React app is setup. Usually developers :man_technologist: go through a time consuming process which involves waiting for create-react-app to finish it's boilerplate setup, followed by installation of dependencies & dev dependencies, setup of folder structure, routing, state management, e.t.c. before it can finally start working on the app. :construction:
Well, now you can grab a cup of :coffee: while Rapid React scaffolds the app for you! :relieved:
Thanks for showing your love for Rapid React which has motivated further to work on some cool new features!
This has been considered after an in-depth advice from Mark Erikson who is a Redux maintainer. You may check his suggestions here which cover RTK as the recommended way to write Redux logic. This would be a breaking change for existing users.
Added support for Redux Thunk middleware!
A much more comprehensive and better looking version update notification!
A notification sound would play once the setup is complete! :bellhop_bell:
assets
, components
, hooks
, services
, utils
, e.t.c.) to scaffold.From your terminal run:
# install the package from NPM
$ npm install rapid-react
Rapid React installs rapid-react
command in your system. To run the tool, you need to invoke this command from your terminal:
# that's it!
$ rapid-react
As soon as run the command you are greeted by the CLI.
From there on, you are asked a couple of question for a tailored experience for your app setup.
The utility would walk you through from following:
Language Preference
Choose between JavaScript and TypeScript
App Name
Enter your app name. By default it fallbacks to my-app.
:white_check_mark: valid app names
foo
123foo
foo123
foo-bar
:x: invalid app names
Foo
Foo-Bar
FooBar
Export Type Preference
Choose between Named and Default.
StyleSheet Preference
Choose between CSS and SCSS.
Routing requirement
Choose either Yes or No.
If required, enter space separated route names
e.g. home login about signIn signUp
:white_check_mark: valid route names
foo
fooBar
FooBar
Foo123
:x: invalid route names
123foo
foo-bar
foo.bar
foo?bar
State management requirement
Choose either Yes or No.
If required, select one
Choose between MobX and Redux. Once chosen you'll be prompted to enter space separated names of stores(in case of MobX) or reducers(in case of Redux). The conventions would be same as routes.
Installing additional Redux libraries
If you chose Redux you'll be prompted to choose from these additional libraries usually used with Redux:
Scaffold folders:
assets
, components
, data
, errors
, fallbacks
, hooks
, layouts
, services
, types
, utils
, validations
.Dependencies:
You can enter space separated dependencies. The conventions would be same as routes. E.g. antd lodash moment
.
:warning: In case you are using TypeScript you'll have to explicitly mention type definition packages required for these dependencies. Such packages usually start with @types/
prefix and are installed as dev dependencies.
Dev Dependencies: You can enter space separated dev dependencies. The conventions would be same as routes. If you're not sure about what a dev dependency is, you can refer to this.
Your contributions are always welcome! Please have a look at the contribution guidelines first. 🎉
Rapid React is licensed under the terms of MIT License.