Code Monkey home page Code Monkey logo

custom-react-scripts's Introduction

☢ custom-react-scripts ☢

Latest version of original react-scripts: 0.8.5

⚠️ Disclaimer:

This is not a fork of create-react-app. It's just a fork of react-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.

(??)## tl;dr

*the features are optional and can be turned on/off individually

❔How to use it

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 SASS, LESS, and CSS modules support by default, but you can remove them at any time by removing the options from the .env file.

📝 Configuration options

Styling

  • REACT_APP_SASS=true - enable SASS support
  • REACT_APP_LESS=true - enable LESS support
  • REACT_APP_STYLUS=true - enable Stylus support
  • REACT_APP_CSS_MODULES - enable CSS modules

Babel

  • REACT_APP_BABEL_STAGE_0=true - enable stage-0 Babel preset
  • REACT_APP_DECORATORS=true - enable decorators support

⚠️ Please note that the Babel features are highly experimental (especially stage-0) and still not a part of the ES specification. Use them at your own risk of breaking backwards compatibility if they don't make the final version of the spec.

Others

  • PORT=3015 - change default port (supported in CRA by default)
  • OPEN_BROWSER=false - don't open browser after running webpack server

(??)You’ll need to have Node >= 4 on your machine.

(??)We strongly recommend to use Node >= 6 and npm >= 3 for faster installation speed and better disk usage. You can use nvm to easily switch Node versions between different projects. (??) (??)This tool doesn’t assume a Node backend. The Node installation is only required for the build tools that rely on it locally, such as Webpack and Babel.

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.

How does it work?

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.

(??) (??)my-app/ (??) README.md (??) node_modules/ (??) package.json (??) .gitignore (??) public/ (??) favicon.ico (??) index.html (??) src/ (??) App.css (??) App.js (??) App.test.js (??) index.css (??) index.js (??) logo.svg (??)

(??)No configuration or complicated folder structures, just the files you need to build your app.
(??)Once the installation is done, you can run some commands inside the project folder: (??) (??)### npm start (??) (??)Runs the app in development mode.
(??)Open http://localhost:3000 to view it in the browser. (??) (??)The page will reload if you make edits.
(??)You will see the build errors and lint warnings in the console. (??) (??)Build errors (??) (??)### npm test (??) (??)Runs the test watcher in an interactive mode.
(??)By default, runs tests related to files changes since the last commit. (??) (??)Read more about testing. (??) (??)### npm run build (??) (??)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.
(??)Your app is ready to be deployed! (??) (??)## User Guide (??) (??)The User Guide includes information on different topics, such as: (??) (??)- Updating to New Releases (??)- Folder Structure (??)- Available Scripts (??)- Syntax Highlighting in the Editor (??)- Displaying Lint Output in the Editor (??)- Changing the Page <title> (??)- Installing a Dependency (??)- Importing a Component (??)- Adding a Stylesheet (??)- Post-Processing CSS (??)- Adding Images and Fonts (??)- Using the public Folder (??)- Using Global Variables (??)- Adding Bootstrap (??)- Adding Flow (??)- Adding Custom Environment Variables (??)- Can I Use Decorators? (??)- Integrating with an API Backend (??)- Proxying API Requests in Development (??)- Using HTTPS in Development (??)- Generating Dynamic <meta> Tags on the Server (??)- Running Tests (??)- Developing Components in Isolation (??)- Making a Progressive Web App (??)- Deployment (??)- Troubleshooting (??) (??)A copy of the user guide will be created as README.md in your project folder. (??) (??)## How to Update to New Versions? (??) (??)Please refer to the User Guide for this and other information. (??) (??)## Philosophy (??) (??)* 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. (??) (??)* Convention over Configuration: You don't need to configure anything by default. 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. (??) (??)## Why Use This? (??) (??)If you’re getting started with React, use create-react-app to automate the build of your app. There is no configuration file, and react-scripts is the only extra build dependency in your package.json. Your environment will have everything you need to build a modern React app: (??) (??)* React, JSX, ES6, and Flow syntax support. (??)* Language extras beyond ES6 like the object spread operator. (??)* A dev server that lints for common errors. (??)* Import CSS and image files directly from JavaScript. (??)* Autoprefixed CSS, so you don’t need -webkit or other prefixes. (??)* A build script to bundle JS, CSS, and images for production, with sourcemaps. (??) (??)The feature set is intentionally limited. It doesn’t support advanced features such as server rendering or CSS modules. The tool is also non-configurable because it is hard to provide a cohesive experience and easy updates across a set of tools when the user can tweak anything. (??) (??)You don’t have to use this. Historically it has been easy to gradually adopt React. However many people create new single-page React apps from scratch every day. We’ve heard loud and clear that this process can be error-prone and tedious, especially if this is your first JavaScript build stack. This project is an attempt to figure out a good way to start developing React apps. (??) (??)### Converting to a Custom Setup (??) (??)If you’re a power user and you aren’t happy with the default configuration, you can “eject” from the tool and use it as a boilerplate generator. (??) (??)Running npm run eject copies all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. Commands like npm start and npm run build will still work, but they will point to the copied scripts so you can tweak them. At this point, you’re on your own. (??) (??)Note: this is a one-way operation. Once you eject, you can’t go back! (??) (??)You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. (??) (??)## Limitations (??) (??)Some features are currently not supported: (??) (??)* Server rendering. (??)* Some experimental syntax extensions (e.g. decorators). (??)* CSS Modules. (??)* LESS or Sass. (??)* Hot reloading of components. (??) (??)Some of them might get added in the future if they are stable, are useful to majority of React apps, don’t conflict with existing tools, and don’t introduce additional configuration. (??) (??)## What’s Inside? (??) (??)The tools used by Create React App are subject to change. (??)Currently it is a thin layer on top of many amazing community projects, such as: (??) (??)* webpack with webpack-dev-server, html-webpack-plugin and style-loader (??)* Babel with ES6 and extensions used by Facebook (JSX, object spread, class properties) (??)* Autoprefixer (??)* ESLint (??)* Jest (??)* and others. (??) (??)All of them are transitive dependencies of the provided npm package. (??) (??)## Contributing (??) (??)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. (??) (??)## Acknowledgements (??) (??)We are grateful to the authors of existing related projects for their ideas and collaboration: (??) (??)* @eanplatter (??)* @insin (??)* @mxstbr (??) (??)## Alternatives (??) (??)If you don’t agree with the choices made in this project, you might want to explore alternatives with different tradeoffs.
(??)Some of the more popular and actively maintained ones are: (??) (??)* insin/nwb (??)* mozilla/neo (??)* NYTimes/kyt (??)* zeit/next.js (??)* gatsbyjs/gatsby (??) (??)Notable alternatives also include: (??) (??)* enclave (??)* motion (??)* quik (??)* sagui (??)* roc (??)* aik (??)* react-app (??)* dev-toolkit (??)* tarec (??) (??)You can also use module bundlers like webpack and Browserify directly.
(??)React documentation includes a walkthrough on this topic.

custom-react-scripts's People

Contributors

anilreddykatta avatar bebbi avatar dceddia avatar eanplatter avatar enoahnetzach avatar existentialism avatar fson avatar gaearon avatar greengremlin avatar hnordt avatar insin avatar johann-sonntagbauer avatar keyz avatar kitze avatar koistya avatar kripod avatar lacker avatar mareksuscak avatar mxstbr avatar n3tr avatar nhajidin avatar pd4d10 avatar ro-savage avatar ryansully avatar sidoshi avatar timer avatar tuchk4 avatar valscion avatar viankakrisna avatar vjeux avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.