https://github.com/chantastic/react-cheat-sheet
A filterable React.js reference site
https://github.com/chantastic/react-cheat-sheet
Last synced: 2 months ago
JSON representation
A filterable React.js reference site
- Host: GitHub
- URL: https://github.com/chantastic/react-cheat-sheet
- Owner: chantastic
- Created: 2015-10-08T19:25:46.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T20:27:26.000Z (over 3 years ago)
- Last Synced: 2025-02-26T22:02:14.429Z (over 1 year ago)
- Language: JavaScript
- Homepage: http://reactcheatsheet.com
- Size: 4.87 MB
- Stars: 183
- Watchers: 6
- Forks: 29
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# React Cheat Sheet
[](https://circleci.com/gh/chantastic/react-cheat-sheet)
[](#contributors)
## Contributing
### Setup
`react-cheat-sheet` is a pretty standard [create-react-app](https://github.com/facebookincubator/create-react-app) app. If you're fimiliar with a CRA app, everything should make sense.
#### Clone, setup, and run the project
```bash
git clone https://github.com/chantastic/react-cheat-sheet.git
cd react-cheat-sheet
yarn
yarn start
```
### Yarn scripts
| Command | Description |
| --- | --- |
| `start` | starts a webpacks sever at [`localhost:3000`](localhost:3000) |
| `test` | runs tests using [Jest](https://facebook.github.io/jest/) |
| `prettier`| reformats all code using [prettier](https://github.com/prettier/prettier) |
| `add-contribs` | adds a contributer to [all-contributorsrc](./.all-contributorsrc) |
| `generate-contribs` | generates a list of contributors on the [README](./README.md) |
### Minor changes
Changing an example is easy.
Find the file with the error and click the Pencil button (`Edit this file`).
Make your changes and commit in the browser.
Github will do the rest for you.
I'll get notified and the change will be fixed on the next deploy.
### Major changes
* Fork
* Make Change
* Run `yarn add-contribs` add yourself as a contributer.
* Run `yarn generate-contribs` to generate an updated README.
* PR back into `chantastic:master`
## Contributors
Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
Michael Chan
Jon Stuebe
Ted Pennings
James Miller
Eugene Zhlobo
Dan Abramov
Alexander Burtsev
Shrayas Rajagopal
Christopher Miller
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!