lukechilds
/
react.dev
mirror of https://github.com/lukechilds/react.dev.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
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.
4063 Commits
2 Branches
0 Tags
148 MiB
 
 
 
 
Tree: 333656c363
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '333656c363'
${ noResults }
Andrew Clark 333656c363
Update version to 16.6.1 		6 years ago
.circleci no cache fallback 6 years ago
.github Update PULL_REQUEST_TEMPLATE.md 7 years ago
content Typo in useReducer docs, the initialCount prop is unused (#1376) 6 years ago
examples Document class contextType as the primary consuming mechanism (#1283) 6 years ago
flow-typed Upgrade to Gatsby v2 (#1104) 6 years ago
gatsby fix: prevent gatsby file detection from breaking path field (#1226) 6 years ago
plugins HTTPS-ify lots of URLs, update some to their newer homes (#1157) 6 years ago
src Update version to 16.6.1 6 years ago
static Add documentation for Hooks proposal 6 years ago
.babelrc Upgrade to Gatsby v2 (#1104) 6 years ago
.eslintignore Updated .eslintignore 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 Bumped docs version 6 years ago
.nvmrc point at 8.x.x release branch instead of exact 8.4 6 years ago
.prettierrc Moved Prettier config to config file 7 years ago
CODE_OF_CONDUCT.md Added COC 6 years ago
CONTRIBUTING.md Update CONTRIBUTING.md (#1234) 6 years ago
LICENSE-DOCS.md Moved the CC license file to cover docs only 7 years ago
README.md Tweaked licensing wording in README slightly 6 years ago
crowdin.yaml Updates CrowdIn configuration to use /lang/folder/file.md 7 years ago
gatsby-browser.js Upgrade to Gatsby v2 (#1104) 6 years ago
gatsby-config.js chore: minor tweaks and run prettier 6 years ago
gatsby-node.js Upgrade to Gatsby v2 (#1104) 6 years ago
package.json Upgrade to latest alpha 6 years ago
yarn.lock Upgrade to latest alpha 6 years ago

README.md

reactjs.org

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

Getting started

Prerequisites

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

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

Guidelines

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

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.

Translation

If you are interesting in translating reactjs.org, please join the Crowdin.

Troubleshooting

  • yarn reset to clear the local cache

License

Content submitted to reactjs.org is CC-BY-4.0 licensed, as found in the LICENSE-DOCS.md file.