Repository files navigation

This repo contains the source code and documentation poweringreact.dev.

1. Git
2. Node and NPM
3. A fork of the repo (for any contributions)
4. A clone of thereactjs.org repo on your local machine

npm i to install the website's npm dependencies

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

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 thecontributing guidelines for the appropriate sections.

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

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

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

1. git add -A && git commit -m "My message" (replacingMy message with a commit message, such asFix header logo on Android) to stage and commit your changes
2. git push my-fork-name the-name-of-my-branch
3. Go to thereactjs.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.

If you are interested in translatingreactjs.org, please see the current translation efforts attranslations.reactjs.org.

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

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

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