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.
54 lines
2.0 KiB
54 lines
2.0 KiB
8 years ago
|
# reactjs.org
|
||
|
|
|
||
|
|
## Getting started
|
||
|
|
|
||
|
|
### Prerequisites
|
||
|
|
|
||
|
|
1. Git
|
||
|
|
1. Node: install version 8.4 or greater
|
||
|
|
1. Yarn: `npm i -g yarn` to install it globally via NPM
|
||
|
|
1. A clone of the [reactjs.org repo](https://github.com/facebook/reactjs.org) on your local machine
|
||
|
|
1. A fork of the repo (for any contributions)
|
||
|
|
|
||
|
|
### Installation
|
||
|
|
|
||
|
|
1. `cd reactjs.org` to go into the project root
|
||
|
|
1. `yarn` to install the website's NPM dependencies
|
||
|
|
|
||
|
|
### Running locally
|
||
|
|
|
||
|
|
1. `yarn dev` to start the hot-reloading development server (powered by [Gatsby](https://www.gatsbyjs.org))
|
||
|
|
1. `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 react repository
|
||
|
|
1. `git pull origin master` to ensure you have the latest main code
|
||
|
|
1. `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
|
||
|
|
1. Save the files and check in the browser
|
||
|
|
1. Changes to React components in `src` will hot-reload
|
||
|
|
1. Changes to markdown files in `content` 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 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
|
||
|
|
1. `git push my-fork-name the-name-of-my-branch`
|
||
|
|
1. Go to the [reactjs.org repo](https://github.com/facebook/reactjs.org) and you should see recently pushed branches.
|
||
|
|
1. Follow GitHub's instructions.
|
||
|
|
1. 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
|