You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
jxom de3bd87f4b Added fbjs eslint config, fixed lint errors and warnings 7 years ago
content Merge pull request #89 from dance2die/issue70 7 years ago
flow-typed Added some basic Flow types to get things started 7 years ago
plugins Prettier formatted flow-typed and plugins dirs 7 years ago
src Added fbjs eslint config, fixed lint errors and warnings 7 years ago
static fix redirect file 7 years ago
.babelrc Migrated Gatsby website source and config 7 years ago
.eslintignore Migrated Gatsby website source and config 7 years ago
.eslintrc Added fbjs eslint config, fixed lint errors and warnings 7 years ago
.flowconfig Added some basic Flow types to get things started 7 years ago
.gitignore Migrated Gatsby website source and config 7 years ago
.nvmrc Migrated Gatsby website source and config 7 years ago
.prettierrc Moved Prettier config to config file 7 years ago
LICENSE-DOCS.md Moved the CC license file to cover docs only 7 years ago
LICENSE.md Added MIT license for website source code 7 years ago
README.md Update Yarn installation instructions 7 years ago
crowdin.yaml Adding Crowdin config file to master repo (#10579) 7 years ago
gatsby-config.js Replaced CC-BY 4.0 license in source code headers with MIT 7 years ago
gatsby-node.js Merge pull request #47 from yangshun/fix-duplicate-redirect 7 years ago
package.json Added fbjs eslint config, fixed lint errors and warnings 7 years ago
yarn.lock Migrated Gatsby website source and config 7 years ago

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