Latest version of original react-scripts: 1.1.14
This is not a fork of
create-react-app
. It's just a fork ofreact-scripts
with simple babel/webpack modifications that can toggle extra features.
The reason for this fork's existence is explained better in this Medium article.
- Decorators
- babel-preset-stage-0
- Less
- Sass
- CSS modules
- Sass modules
- Less modules
- Stylus modules
*the features are optional and can be turned on/off individually
create-react-app my-app --scripts-version custom-react-scripts
Modify the .env
file in the root of the generated project, and add any of the configuration options below π to enable that feature.
The generated project comes with every option turned on by default, but you can remove them at any time by removing the options from the .env
file.
npm uninstall --save react-scripts;
npm install --save custom-react-scripts;
Add a .env.
file with the desired features.
=========
npx create-react-app my-app
cd my-app
npm start
(npx comes with npm 5.2+ and higher, see instructions for older npm versions)
Then open http://localhost:3000/ to see your app.
When youβre ready to deploy to production, create a minified bundle with npm run build
.
REACT_APP_SASS=true
- enable SASS supportREACT_APP_LESS=true
- enable LESS supportREACT_APP_STYLUS=true
- enable Stylus supportREACT_APP_CSS_MODULES=true
- enable CSS modulesREACT_APP_SASS_MODULES=true
- enable Sass modulesREACT_APP_LESS_MODULES=true
- enable Less modulesREACT_APP_STYLUS_MODULES=true
- enable Stylus modulesREACT_APP_CSS_MODULE_CLASSNAME_TEMPLATE='module-[sha512:hash:base32]-[name]-[local]'
- add custom CSS Module hash ident name
Note: to use modules the file must be named in the following format: $name.module.$preprocessorName
.
For example styles.module.css
or header.module.sass
or footer.module.less
, etc. Files that are not prefixed with module will be parsed normally.
REACT_APP_BABEL_STAGE_0=true
- enable stage-0 Babel presetREACT_APP_DECORATORS=true
- enable decorators support
REACT_APP_WEBPACK_DASHBOARD=true
- Enables connection to the webpack-dashboard Electron app (the app must be installed on local machine)
The create-react-app
app doesn't allow user configuration and modifications for few reasons:
- Some of the babel presets and plugins that people might use are experimental. If they're used in a project and then they don't make it in the ES spec, they will break backwards compatibility.
- It's hard to maintain code for all of these custom configurations that people want to use.
But people still want to use some of these features, and they're either ejecting their CRA app, or just don't use create-react-app
because they're just missing X feature.
So instead of searching npm for a react-scripts
fork with the X feature you need, this fork provides support for all of these extra features with simply adding a line in the .env
config.
The CRA team recently added support for an .env
file in the root of the generated CRA project.
From the original readme:
To define permanent environment vairables, create a file called .env in the root of your project:
REACT_APP_SECRET_CODE=abcdef
I just added support for extra environment variables that actually turn on certain plugins, babel plugins, presets, and loaders in the webpack and babel configs of react-scripts
.
Youβll need to have Node >= 6 on your local development machine (but itβs not required on the server). You can use nvm (macOS/Linux) or nvm-windows to easily switch Node versions between different projects.
To create a new app, you may choose one of the following methods:
npx create-react-app my-app
(npx comes with npm 5.2+ and higher, see instructions for older npm versions)
Temporary merge branch 2
npm init react-app my-app
npm init <initializer>
is available in npm 6+
yarn create react-app 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:
<<<<<<<<< Temporary merge branch 1
I will put all of my efforts into supporting this fork to be always on par with features with the newest create-react-app
and react-scripts
versions.
my-app
βββ README.md
βββ node_modules
βββ package.json
βββ .gitignore
βββ public
β βββ favicon.ico
β βββ index.html
β βββ manifest.json
βββ src
βββ App.css
βββ App.js
βββ App.test.js
βββ index.css
βββ index.js
βββ logo.svg
βββ registerServiceWorker.js
No configuration or complicated folder structures, just the files you need to build your app.
Once the installation is done, you can open your project folder:
cd my-app
Inside the newly created project, you can run some built-in commands:
Runs the app in development mode.
Open http://localhost:3000 to view it in the browser.
The page will automatically reload if you make changes to the code.
You will see the build errors and lint warnings in the console.
Runs the test watcher in an interactive mode.
By default, runs tests related to files changed since the last commit.
Builds the app for production to the build
folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
By default, it also includes a service worker so that your app loads from local cache on future visits.
Your app is ready to be deployed.
The User Guide includes information on different topics, such as:
- Updating to New Releases
- Folder Structure
- Available Scripts
- Supported Browsers
- Supported Language Features and Polyfills
- Syntax Highlighting in the Editor
- Displaying Lint Output in the Editor
- Formatting Code Automatically
- Debugging in the Editor
- Changing the Page
<title>
- Installing a Dependency
- Importing a Component
- Code Splitting
- Adding a Stylesheet
- Post-Processing CSS
- Adding a CSS Preprocessor (Sass, Less etc.)
- Adding Images, Fonts, and Files
- Using the
public
Folder - Using Global Variables
- Adding Bootstrap
- Adding Flow
- Adding a Router
- Adding Custom Environment Variables
- Can I Use Decorators?
- Fetching Data with AJAX Requests
- Integrating with an API Backend
- Proxying API Requests in Development
- Using HTTPS in Development
- Generating Dynamic
<meta>
Tags on the Server - Pre-Rendering into Static HTML Files
- Running Tests
- Debugging Tests
- Developing Components in Isolation
- Publishing Components to npm
- Making a Progressive Web App
- Analyzing the Bundle Size
- Deployment
- Advanced Configuration
- Troubleshooting
A copy of the user guide will be created as README.md
in your project folder.
Please refer to the User Guide for this and other information.
-
One Dependency: There is just one build dependency. It uses Webpack, Babel, ESLint, and other amazing projects, but provides a cohesive curated experience on top of them.
-
No Configuration Required: You don't need to configure anything. Reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.
-
No Lock-In: You can βejectβ to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off.
Your environment will have everything you need to build a modern single-page React app:
- React, JSX, ES6, and Flow syntax support.
- Language extras beyond ES6 like the object spread operator.
- Autoprefixed CSS, so you donβt need
-webkit-
or other prefixes. - A fast interactive unit test runner with built-in support for coverage reporting.
- A live development server that warns about common mistakes.
- A build script to bundle JS, CSS, and images for production, with hashes and sourcemaps.
- An offline-first service worker and a web app manifest, meeting all the Progressive Web App criteria.
- Hassle-free updates for the above tools with a single dependency.
Check out this guide for an overview of how these tools fit together.
The tradeoff is that these tools are preconfigured to work in a specific way. If your project needs more customization, you can "eject" and customize it, but then you will need to maintain this configuration.
Create React App is a great fit for:
- Learning React in a comfortable and feature-rich development environment.
- Starting new single-page React applications.
- Creating examples with React for your libraries and components.
Hereβs a few common cases where you might want to try something else:
-
If you want to try React without hundreds of transitive build tool dependencies, consider using a single HTML file or an online sandbox instead.
-
If you need to integrate React code with a server-side template framework like Rails or Django, or if youβre not building a single-page app, consider using nwb, or Neutrino which are more flexible. For Rails specifically, you can use Rails Webpacker.
-
If you need to publish a React component, nwb can also do this, as well as Neutrino's react-components preset.
-
If you want to do server rendering with React and Node.js, check out Next.js or Razzle. Create React App is agnostic of the backend, and just produces static HTML/JS/CSS bundles.
-
If your website is mostly static (for example, a portfolio or a blog), consider using Gatsby instead. Unlike Create React App, it pre-renders the website into HTML at the build time.
-
If you want to use TypeScript, consider using create-react-app-typescript.
-
If you want to use Parcel instead of Webpack as your bundler, consider using create-react-app-parcel.
-
Finally, if you need more customization, check out Neutrino and its React preset.
All of the above tools can work with little to no configuration.
If you prefer configuring the build yourself, follow this guide.
We'd love to have your helping hand on create-react-app
! See CONTRIBUTING.md for more information on what we're looking for and how to get started.
Looking for something similar, but for React Native?
Check out Create React Native App.
We are grateful to the authors of existing related projects for their ideas and collaboration:
Create React App is open source software licensed as MIT.