README.md

React + Webpack Starter

This starter kit is designed to get you up and running with a bunch of awesome front-end technologies.

The primary goal of this project is to provide a stable foundation upon which to build modern web appliications. Its purpose is not to dictate your project structure or to demonstrate a complete real-world application, but to provide a set of tools intended to make front-end development robust and easy.

Quickstart

$ npx create-react-webpack-project my-app # or specify flag `-i` to use interactive menu
$ cd my-app
$ npm start

the generated project will vary in the presence of the following flags:

Flag	What is it for?
-i, --interactive	use interactive mode to bootstrap your app
--verbose	print additional logs.
--info	print environment debug info.
--nodeps	will no install dependencies on the generated project.
--use-npm	will use npm as command.
--template <template>	specify template to use for initial setup
--cra [template]	use create-react-app for initial setup with optional example
--gatsby <template>	use gatsby using an existing boilerplate for initial setup
--next <example>	use create-next-app for initial setup using a nextjs example
--inplace	apply setup to an existing project.
-a <alias>	will setup webpack alias. app by default.
--src-dir <src-dir>	dir name to put content under [src]/. src by default.
--typescript	add TypeScript support.
--i18n	add i18n setup using react-i18n and async backend with locale and timezone support.
--redux	add redux support and setup using redux thunk middleware by default.
--redux --saga	add redux support and setup using redux saga middleware.
--recoil	add recoil.js support and setup the state management library for React.
--ant-design	add ant-design setup with ant-design icons package.
--bootstrap	add bootstrap and bootstrap-react setup with theme config.
--material-ui	add material ui setup with SVG icons.
--semantic-ui	add semantic ui and semantic ui react setup with theme config.
--ionic	generate cross platform setup using ionic react and capacitor.
--docker	generate dockerfiles for development and production environments.
--android-tools	generate dockerfiles to perform android emulation, testing and apk generation.

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)

Creating an app

You’ll need to have Node 12.14.0 or later on your local development machine (but it’s not required on the server). You can use fnm to easily switch Node versions between different projects.

To create a new app, you may choose one of the following methods:

npx

$ npx create-react-webpack-project my-app

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)

npm

$ npm init react-webpack-project my-app

npm init <initializer> is available in npm 6+

yarn

$ yarn create react-webpack-project my-app

yarn create is available in Yarn 0.25+

It will create a directory called my-app inside the current folder.
Inside that directory, it will generate the initial project structure and install the transitive dependencies.

Contributors

Made with contributors-img.