Skip to content

Commit b834d00

Browse files
committed
initial readme
1 parent a03fd7f commit b834d00

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# React Rewind : A Time Travel Debugger for React
2+
3+
A time travel debugger tool made to work with react 16.8+.
4+
- useReducer
5+
- useState
6+
React Rewind is in active development. Please follow this repo for contribution guidelines and our development road map.
7+
## Getting Started
8+
9+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
10+
11+
### Prerequisites
12+
13+
Your application must be using the hooks useReducer or useState for actions to be record.
14+
15+
### Installing
16+
React Rewind is available as a Chrome extension through the Google Chrome Web Store.
17+
On your application page open Chrome Developer tools and select React Rewind from the tool bar.
18+
Click `Record` and begin interacting with your application.
19+
20+
If you prefer to install locally, setup instructions are as follows:
21+
```
22+
git clone https://github.com/reactrewind/react-rewind.git`
23+
cd reactrewind
24+
npm install
25+
npm run rewind
26+
```
27+
28+
Head to [chrome://extensions/](chrome://extensions/)
29+
Click `Load Unpacked` button and upload the chrome folder, located at react-rewind/src/browser/chrome
30+
On your application page open Chrome Developer tools and select React Rewind from the tool bar.
31+
Click `Record` and begin interacting with your application.
32+
33+
As you interact with your application actions will populate in the events panel. These actions are clickable and will change the state of your page. The actions can be viewed in more detail in the right panel by inspecting the actions, effects, and state. The bottom panel allow you to rewind, fast forward,and play through all recorded actions.
34+
35+
## Running the tests
36+
37+
`npm run tests`
38+
39+
## Contributing
40+
41+
Please fork this repo. We welcome pull requests. For suggestions or to report bugs please log an issue.
42+
43+
## Versioning
44+
45+
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags).
46+
47+
## Authors
48+
49+
[Brandon Murphy](https://github.com/murphybrandon) | [Victor Varaschin](https://github.com/victorvrv) | [Kia Colbert](https://github.com/kiacolbert) | [Gabor Mowiena](https://github.com/GaberMowiena)
50+
51+
## License
52+
53+
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details
54+

0 commit comments

Comments
 (0)