This repo contains the source code and documentation powering reactjs.org.
- Git
- Node: install version 8.4 or greater
- Yarn: See Yarn website for installation instructions
- A clone of the reactjs.org repo on your local machine
- A fork of the repo (for any contributions)
cd reactjs.orgto go into the project rootyarnto install the website's npm dependencies
yarn devto start the hot-reloading development server (powered by Gatsby)open http://localhost:8000to open the site in your favorite browser
git checkout masterfrom any folder in your localreactjs.orgrepositorygit pull origin masterto ensure you have the latest main codegit checkout -b the-name-of-my-branch(replacingthe-name-of-my-branchwith a suitable name) to create a branch
- Follow the "Running locally" instructions
- Save the files and check in the browser
- Changes to React components in
srcwill hot-reload - Changes to markdown files in
contentwill hot-reload - If working with plugins, you may need to remove the
.cachedirectory and restart the server
- If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
- Run
yarn check-allfrom the project root. (This will run Prettier, ESLint, and Flow.)
git add -A && git commit -m "My message"(replacingMy messagewith a commit message, such asFixed header logo on Android) to stage and commit your changesgit push my-fork-name the-name-of-my-branch- Go to the reactjs.org repo and you should see recently pushed branches.
- Follow GitHub's instructions.
- If possible, include screenshots of visual changes. A Netlify build will also be automatically created once you make your PR so other people can see your change.
yarn resetto clear the local cache