reactjs.org

This repo contains the source code and documentation powering react.dev.

Getting started

Prerequisites

1. Git
2. Node: any 12.x version starting with v12.0.0 or greater
3. Yarn: See Yarn website for installation instructions
4. A fork of the repo (for any contributions)
5. A clone of the reactjs.org repo on your local machine

Installation

yarn to install the website's npm dependencies

Running locally

1. yarn dev to start the development server (powered by Next.js)
2. open http://localhost:3000 to open the site in your favorite browser

Contributing

Guidelines

The documentation is divided into several sections with a different tone and purpose. If you plan to write more than a few sentences, you might find it helpful to get familiar with the contributing guidelines for the appropriate sections.

Create a branch

1. git checkout main from any folder in your local reactjs.org repository
2. git pull origin main to ensure you have the latest main code
3. git checkout -b the-name-of-my-branch (replacing the-name-of-my-branch with a suitable name) to create a branch

Make the change

1. Follow the "Running locally" instructions
2. Save the files and check in the browser
3. Changes to React components in src will hot-reload
4. Changes to markdown files in content will hot-reload
5. If working with plugins, you may need to remove the .cache directory and restart the server

Test the change

1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
2. Run yarn check-all. (This will run Prettier, ESLint and validate types.)

Push it

1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fix header logo on Android) to stage and commit your changes
2. git push my-fork-name the-name-of-my-branch
3. Go to the reactjs.org repo and you should see recently pushed branches.
4. Follow GitHub's instructions.
5. If possible, include screenshots of visual changes. A preview build is triggered after your changes are pushed to GitHub.

Translation

If you are interested in translating reactjs.org, please see the current translation efforts at translations.reactjs.org.

If your language does not have a translation and you would like to create one, please follow the instructions at reactjs.org Translations.

Troubleshooting

• yarn reset to clear the local cache

Acknowledgements

This website was built by forking the source code of the React documentation website at react.dev at the source repository. We are thankful to all of the people who helped create React and the documentation website as mentioned in the original website.

License

Contents in this repo is CC-BY-4.0 licensed, as found in the LICENSE.md file.