Contributing

Contributions to react-app-rewired are welcome! Whether you're fixing a bug, improving documentation, or suggesting a new feature, your help is appreciated.

Submitting an Issue

Before submitting an issue, please ensure it is an issue with the code in this repository, not a question about how to configure webpack. For general webpack questions, please use platforms like Stack Overflow.

When creating an issue, please provide:

  • A clear and descriptive title.
  • The version of react-app-rewired, react-scripts, and node you are using.
  • A description of the problem and steps to reproduce it.
  • Your config-overrides.js file, if relevant.

Development Setup

To get started with developing react-app-rewired locally, you will need Yarn installed.

The project includes a test React application in the test/react-app directory which is used for development and testing.

Quick Start

To set up your local environment and run the test app:

  1. Clone the repository:

    git clone https://github.com/timarney/react-app-rewired.git
    cd react-app-rewired

  2. Run the setup script: This command installs all dependencies for both the root project and the test app. It also uses yarn link to make the test app use your local version of react-app-rewired.

    yarn setup

  3. Start the test app: This will start the development server for the test React application.

    yarn start

  4. Tear down the environment: When you are finished, run the teardown script to unlink the packages and remove all node_modules directories.

    yarn teardown

Development Commands

Here is a complete list of the available development scripts from the root package.json:

  • yarn setup: Installs all dependencies and links test/react-app.
  • yarn start: Starts the test React app in development mode.
  • yarn build: Creates a production build of the test React app.
  • yarn test: Runs the test suite for the test React app.
  • yarn teardown: Unlinks test/react-app and removes all dependencies.