Facebook/react
1
0
Fork 0
mirror of https://github.com/facebook/react.git synced 2025-11-01 09:12:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Gatsby] README.md instructions (#10945)

Browse Source 
* Padded out README.md instructions

* fixed markdown links and added reloading notes

* added more yarn instructions

* removed html.js instruction
This commit is contained in:
Joe Critchley
2017-09-29 00:47:06 +01:00
committed by Dan Abramov
parent d87804abc2
commit e271e13809
1 changed files with 52 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/README.md
+52 -13
View File
@@ -1,16 +1,55 @@
# React documentation site
# React — documentation site
To get setup:
```
yarn install
```
## Getting started
To run the dev server:
```
yarn run dev
```
### Prerequisites
To clear the local cache:
```
yarn run reset
```
1. Git
1. Node: install version 7.6 or greater
1. Yarn: `npm i -g yarn` to install it globally via NPM
1. A clone of the [React repo](https://github.com/facebook/react) on your local machine
1. A fork of the repo (for any contributions)
### Installation
1. `cd react` to go into the project root
1. `yarn` to install the main NPM dependencies
1. `cd www` to go into the website project
1. `yarn` to install the website's NPM dependencies
### Running locally
1. `yarn dev` to start the hot-reloading development server powered by Gatsby
1. `open http://localhost:8000` to open the site in your favourite browser
## Contributing
### Create a branch
1. `git checkout master` from any folder in your local react repository
1. `git pull origin master` to ensure you have the latest main code
1. `git checkout -b wwwTheNameOfMyChange` (replacing `TheNameOfMyChange` with a suitable name) to create a branch
### Make the change
1. Follow the "Running locally" instructions
1. Save the files and check in the browser
1. Any React components in `src/components` or `src/templates` will hot-reload
1. 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.
1. Run `yarn prettier-all && yarn lint` from the project root (outside of `www`)
### 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
1. `git push yourname wwwTheNameOfMyChange`
1. Go to the [React repo](https://github.com/facebook/react) and you should see recently pushed branches.
1. ... follow GitHub's instructions...
1. If possible, include any 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