π οΈ
Rapid React
π οΈ for rapid scaffolding of React apps,
with
Create React App under the hood.
A light weight interactive CLI Automation Tool
Built with
About β’ Features β’ Requirements β’ Installation β’ Documentation β’ Road Map β’ Contributing β’ License
βΉοΈ
About Rapid React is an interactive CLI tool which automates the repetitive steps involved every time a new React app is setup. Usually developers
Well, now you can grab a cup of
π
Rapid React 2.0 is out!
Thanks for showing your love for Rapid React which has motivated further to work on some cool new features!
-
Rapid React has been re-written from React Redux to Redux Toolkit APIs. This would dramatically reduce the boilerplate code required to work with Redux and further cut down your development efforts.
ποΈ
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!
ποΈ
π
Features - Get notification every time an update is available.
βοΈ - Supports both JavaScript and TypeScript.
π - Installs both dependencies and dev dependencies.
- Supports popularly used CSS preprocessor SASS!
π₯ - Choose from commonly used folders (
assets
,components
,hooks
,services
,utils
, e.t.c.) to scaffold. - Scaffolds custom folder as well.
- Choose preferred export type: named/default.
π€ - Setups routing with user defined routes.
- Setups Redux state management with user defined reducers along with:
- Setups MobX state management with user defined stores.
- ...and much more!
π
β
Requirements - Node.js installed on your system.
- An active internet connection for CLI to work.
π
Installation From your terminal run:
# install the package from NPM
$ npm install rapid-react
π
Documentation 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.β valid app names
foo
123foo
foo123
foo-barβ 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
β valid route names
foo
fooBar
FooBar
Foo123β 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:- Redux Logger
- Redux Thunk
- Redux Saga
-
-
Scaffold folders:
-
Standard
You can choose from commonly used folder to scaffold:assets
,components
,data
,errors
,fallbacks
,hooks
,layouts
,services
,types
,utils
,validations
. -
Custom
You can enter space separated folders. The conventions would be same as routes.
-
Standard
-
Dependencies:
You can enter space separated dependencies. The conventions would be same as routes. E.g.antd lodash moment
.
β οΈ 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.
π€
Contributing Your contributions are always welcome! Please have a look at the contribution guidelines first.
π
License Rapid React is licensed under the terms of MIT License.