| 1 | # react-scripts
|
| 2 |
|
| 3 | This package includes scripts and configuration used by [Create React App](https://github.com/jdcrensh/create-react-app/tree/jdcrensh).<br>
|
| 4 | Please refer to its documentation:
|
| 5 |
|
| 6 | - [Getting Started](https://github.com/jdcrensh/create-react-app/blob/jdcrensh/README.md#getting-started) – How to create a new app.
|
| 7 | - [User Guide](https://github.com/jdcrensh/create-react-app/blob/jdcrensh/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
|
| 8 |
|
| 9 | ## Configuration & Plugin Support (unofficial)
|
| 10 |
|
| 11 | This is an unofficial fork that extends Create React App with an interface for plugins and general configuration.
|
| 12 |
|
| 13 | ## Configuration
|
| 14 |
|
| 15 | The ES5 module exported by `cra.config.js` at the app's root is used for configuration. The config module expects the same interface as plugins do with exception to the `plugins` property.
|
| 16 |
|
| 17 | ### Example
|
| 18 |
|
| 19 | ```js
|
| 20 | module.exports = {
|
| 21 | // Load plugins by name and/or by reference. Loading plugins by name is for
|
| 22 | // convenience, eg. `'css-modules'` is the same as `require('react-scripts-plugin-css-modules')`
|
| 23 | plugins: ['css-modules', require('./my-internal-plugin')],
|
| 24 |
|
| 25 | // Webpack configuration
|
| 26 | apply: (config, options) => {
|
| 27 | return config;
|
| 28 | },
|
| 29 | };
|
| 30 | ```
|
| 31 |
|
| 32 | ## Plugin Listing
|
| 33 |
|
| 34 | * [react-scripts-plugin-css-modules](https://www.npmjs.com/package/react-scripts-plugin-css-modules)
|
| 35 | * [react-scripts-plugin-no-hashes](https://www.npmjs.com/package/react-scripts-plugin-no-hashes)
|
| 36 | * [react-scripts-plugin-no-minify](https://www.npmjs.com/package/react-scripts-plugin-no-minify)
|
| 37 | * [react-scripts-plugin-scss](https://www.npmjs.com/package/react-scripts-plugin-scss)
|