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.
3415 Commits
2 Branches
0 Tags
148 MiB
 
 
 
 
Tree: 7db107b2fc
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '7db107b2fc'
${ noResults }
Alex Krolick 7db107b2fc
+ "default value" comment 		7 years ago
.circleci Update circle config 7 years ago
.github fix typo 7 years ago
content Add ref forwarding, lifecycle examples 7 years ago
examples + "default value" comment 7 years ago
flow-typed Add flow types to utils 7 years ago
gatsby Removed unhelpful build script warning 7 years ago
plugins Re-ran Prettier after version bump 7 years ago
src Add in-page TOC 7 years ago
static Clarify what single-file HTML page is for 7 years ago
.babelrc Migrated Gatsby website source and config 7 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 nit :) 7 years ago
.nvmrc Migrated Gatsby website source and config 7 years ago
.prettierrc Moved Prettier config to config file 7 years ago
.prettierrc.examples Update Prettier line-widths for example code 7 years ago
CONTRIBUTING.md Change bold text to headings to add id for links 7 years ago
LICENSE-DOCS.md Moved the CC license file to cover docs only 7 years ago
README.md Merge pull request #576 from isaacchien/patch-1 7 years ago
crowdin.yaml Updates CrowdIn configuration to use /lang/folder/file.md 7 years ago
gatsby-config.js Re-ran Prettier after version bump 7 years ago
gatsby-node.js Split gatsby-node into separate files 7 years ago
package.json Update gatsby (#590) 7 years ago
yarn.lock Update gatsby (#590) 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 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

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