mirror of https://github.com/reactjs/react.dev.git synced 2026-02-23 20:23:08 +00:00

Go to file

Liam O'Boyle ec4dc73b8f Note that polyfills are required for some supported browsers too.

The "Browser Support" section of react-dom indicates that IE9 and above
is supported, but fails to note that the support does require additional
polyfills in some cases.  A link is added to the javascript environment
docs which already explains the polyfills required (Map, Set and rAF).

2017-11-29 09:02:08 +11:00

.circleci

Update circle config

2017-10-11 21:18:59 +11:00

.github

fix typo

2017-11-27 01:43:49 -08:00

content

Note that polyfills are required for some supported browsers too.

2017-11-29 09:02:08 +11:00

examples

Changed trailing-commas to es5, moved example config to separate rc file

2017-11-23 08:36:26 -08:00

flow-typed

Add react-helmet flow type stub

2017-10-17 10:15:20 +02:00

gatsby

Split gatsby-node into separate files

2017-11-10 11:04:00 +00:00

plugins

WIP upgrade to new gatsby-remark-code-repls

2017-11-09 18:10:40 +00:00

src

Pretty print

2017-11-27 10:18:39 +01:00

static

fix redirect file

2017-10-07 09:41:29 -03:00

.babelrc

Migrated Gatsby website source and config

2017-10-04 14:56:10 -07:00

.eslintignore

Updated .eslintignore

2017-11-07 11:09:27 +00:00

.eslintrc

Added fbjs eslint config, fixed lint errors and warnings

2017-10-10 08:41:44 +11:00

.flowconfig

Added some basic Flow types to get things started

2017-10-05 15:33:18 -07:00

.gitignore

nit :)

2017-10-11 13:44:13 -07:00

.nvmrc

Migrated Gatsby website source and config

2017-10-04 14:56:10 -07:00

.prettierrc

Moved Prettier config to config file

2017-10-05 08:07:32 -07:00

.prettierrc.examples

Changed trailing-commas to es5, moved example config to separate rc file

2017-11-23 08:36:26 -08:00

CONTRIBUTING.md

Change bold text to headings to add id for links

2017-11-23 12:12:49 -08:00

crowdin.yaml

Updates CrowdIn configuration to use /lang/folder/file.md

2017-11-17 15:19:12 -08:00

gatsby-config.js

Fix lint warnings

2017-11-09 22:57:40 +00:00

gatsby-node.js

Split gatsby-node into separate files

2017-11-10 11:04:00 +00:00

LICENSE-DOCS.md

Moved the CC license file to cover docs only

2017-10-07 07:59:43 -07:00

package.json

Changed trailing-commas to es5, moved example config to separate rc file

2017-11-23 08:36:26 -08:00

README.md

Put comma after If possible

2017-10-12 11:58:27 +02:00

yarn.lock

Parallelize some yarn scripts with npm-run-all

2017-11-17 08:58:28 -08:00

README.md

reactjs.org

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

Getting started

Prerequisites

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)

Installation

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

Running locally

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

Contributing

Create a branch

git checkout master from any folder in your local reactjs.org repository
git pull origin master to ensure you have the latest main code
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

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

Test the change

If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile.
Run yarn check-all from the project root. (This will run Prettier, ESLint, and Flow.)

Push it

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
git 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.

Troubleshooting

yarn reset to clear the local cache