The React documentation website
Branch: master
Clone or download
Pull request Compare This branch is 1024 commits behind reactjs:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
content
examples
flow-typed
gatsby
plugins
src
static
.babelrc
.eslintignore
.eslintrc
.flowconfig
.gitignore
.nvmrc
.prettierrc
.prettierrc.examples
CONTRIBUTING.md
LICENSE-DOCS.md
README.md
crowdin.yaml
gatsby-config.js
gatsby-node.js
package.json
yarn.lock

README.md

reactjs.org

This repo contains the source code and documentation powering reactjs.org.

Getting started

Prerequisites

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

Installation

  1. cd reactjs.org to go into the project root
  2. yarn to install the website's npm dependencies

Running locally

  1. yarn dev to start the hot-reloading development server (powered by Gatsby)
  2. open http://localhost:8000 to open the site in your favorite browser

Contributing

Create a branch

  1. git checkout master from any folder in your local reactjs.org repository
  2. git pull origin master 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 from the project root. (This will run Prettier, ESLint, and Flow.)

Push it

  1. git add -A && git commit -m "My message" (replacing My message with a commit message, such as Fixed 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 Netlify build will also be automatically created once you make your PR so other people can see your change.

Troubleshooting

  • yarn reset to clear the local cache