Skip to content

Commit 8d6ad52

Browse files
committed
Merge branch 'master' into dev
2 parents 46bbe4b + 368a054 commit 8d6ad52

20 files changed

+134
-125
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,5 @@ tictactoe
66
parents
77
coverage
88
src/extension/build.zip
9+
src/extension/build.crx
10+
src/extension/build/key.pem

.travis.yml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,3 @@ services:
22
- docker
33
script:
44
- docker-compose up --abort-on-container-exit
5-
deploy:
6-
provider: script
7-
skip_cleanup: true
8-
on:
9-
branches:
10-
only:
11-
- dev
12-
- master

assets/readme_logo.png

33.6 KB
Loading

demo2.gif renamed to demo.gif

File renamed without changes.

package/demo.gif

-114 KB
Loading

package/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "reactime",
3-
"version": "2.0.1",
3+
"version": "2.0.3",
44
"description": "A library that helps debug React by memorizing the state of components with every render.",
55
"main": "index.js",
66
"repository": {

package/react-time-travel-1.0.1.tgz

-49.4 KB
Binary file not shown.

package/react-time-travel-1.0.4.tgz

-54.2 KB
Binary file not shown.

package/readme.md

Lines changed: 32 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,34 @@
1-
# Reactime
1+
<p align="center">
2+
<img src ="./assets/readme_logo.png" width="400"/>
3+
</p>
4+
5+
# Reactime: A Time Travel Debugger for React
26

3-
![GitHub](https://img.shields.io/github/license/oslabs-beta/reactime)
4-
![Travis (.com) branch](https://img.shields.io/travis/com/oslabs-beta/reactime/dev?label=dev%20build)
5-
![Travis (.com) branch](https://img.shields.io/travis/com/oslabs-beta/reactime/master?label=master%20build)
6-
![npm](https://img.shields.io/npm/v/reactime?color=green)
7-
![David](https://img.shields.io/david/oslabs-beta/reactime)
8-
![DevDependencies](https://img.shields.io/david/dev/oslabs-beta/reactime.svg)
9-
![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/oslabs-beta/reactime)
7+
[![GitHub](https://img.shields.io/github/license/oslabs-beta/reactime)](https://github.com/oslabs-beta/reactime)
8+
[![Build Status](https://travis-ci.com/oslabs-beta/reactime.svg?branch=master)](https://travis-ci.com/oslabs-beta/reactime)
9+
[![npm version](https://badge.fury.io/js/reactime.svg)](http://badge.fury.io/js/reactime)
10+
[![Dependencies](https://david-dm.org/oslabs-beta/reactime.svg)](https://david-dm.org/oslabs-beta/reactime#info=dependencies)
11+
[![DevDependencies](https://david-dm.org/oslabs-beta/reactime/dev-status.svg)](https://david-dm.org/oslabs-beta/reactime?type=dev)
12+
[![Vulnerabilities](https://snyk.io/test/github/oslabs-beta/reactime/badge.svg)](https://snyk.io/test/github/oslabs-beta/reactime)
13+
14+
[![NPM](https://nodei.co/npm/reactime.png)](https://nodei.co/npm/reactime/)
1015

1116
<p align="center">
12-
<img src="demo.gif" alt="Demo of Reactime">
17+
<img src="demo.gif" alt="Demo of Reactime" style="width: 55%">
1318
</p>
1419

15-
A debugging tool for React. Records state whenever state is changed and allows user to jump to any previous recorded state.
20+
Reactime is a debugging tool for React developers. It records state whenever state is changed and allows user to jump to any previous recorded state.
21+
22+
One important thing to note. This devtool is for React apps using only stateful components and prop drilling. If you're using Redux, Hooks, Context, or functional components, this devtool will not function on your app.
1623

17-
Two parts are needed for this tool to function. The chrome extension must be installed, and the NPM package must be installed and used in the React code.
24+
Another thing is that this library does not work well when mixing React with direct DOM manipulation. Since DOM manipulation doesn't change any React state, this library cannot record or even detect that change. Of course, you should be avoiding mixing the two in the first place.
25+
26+
Two parts are needed for this tool to function. The <a href="https://chrome.google.com/webstore/detail/react-time-travel/cgibknllccemdnfhfpmjhffpjfeidjga">chrome extension</a> must be installed, and the NPM package must be installed and used in the React code.
27+
28+
After successfully installing the chrome extension, you can test Reactime functionalities in the demo repositories below.
29+
30+
- <a href="http://reactime-demo1.us-east-1.elasticbeanstalk.com/">Calculator</a>
31+
- <a href="http://reactime-demo2.us-east-1.elasticbeanstalk.com/">Bitcoin Price Index</a>
1832

1933
## Installing
2034

@@ -29,12 +43,12 @@ npm i reactime
2943
3. Call the library method on your root container after rendering your App.
3044

3145
```
32-
const reactTimeTravel = require('reactime');
46+
const reactime = require('reactime');
3347
3448
const rootContainer = document.getElementById('root');
35-
ReactDom.render(<App />, rootContainer);
49+
ReactDOM.render(<App />, rootContainer);
3650
37-
reactTimeTravel(rootContainer);
51+
reactime(rootContainer);
3852
```
3953

4054
4. Done! That's all you have to do to link your React project to our library.
@@ -43,7 +57,7 @@ reactTimeTravel(rootContainer);
4357

4458
After installing both the Chrome extension and the npm package, just open up your project in the browser.
4559

46-
Then open up your Chrome DevTools. There'll be a new tab called reactime.
60+
Then open up your Chrome DevTools. There'll be a new tab called Reactime.
4761

4862
## Features
4963

@@ -53,13 +67,11 @@ Whenever state is changed (whenever setState is called), this extension will cre
5367

5468
### Viewing
5569

56-
You can click on a snapshot to view your app's state. State can be visualized in a JSON or a tree.
57-
58-
The selected snapshot can also be diffed/compared with the current dom.
70+
You can click on a snapshot to view your app's state. State can be visualized in a JSON or a tree. Also, snapshots can be diffed with the previous snapshot, which can be viewed under the Diff tab.
5971

6072
### Jumping
6173

62-
The most important feature of all. Jumping to any previous recorded snapshot. Hitting the jump button on any snapshot will change the dom by setting their state. One important thing to note. This library does not work well when mixing React with direct DOM manipulation. Since DOM manipulation doesn't change any React state, this library cannot record or even detect that change. Of course, you should be avoiding mixing the two in the first place.
74+
Jumping is the most important feature of all. It allows you to jump to any previous recorded snapshots. Hitting the jump button on any snapshot will change the DOM by setting their state.
6375

6476
### Others
6577

@@ -70,7 +82,7 @@ Other handy features include:
7082
- a play button to move through snapshots automatically
7183
- a pause which button stops recording each snapshot
7284
- a lock button to freeze the DOM in place. setState will lose all functionality while the extension is locked
73-
- a persist button to keep snapshots upon refresh. handy when changing code and debugging
85+
- a persist button to keep snapshots upon refresh (handy when changing code and debugging)
7486
- export/import the current snapshots in memory
7587

7688
## Authors

readme.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
1-
# Reactime
1+
<p align="center">
2+
<img src ="./assets/readme_logo.png" width="400"/>
3+
</p>
4+
5+
# Reactime: A Time Travel Debugger for React
26

37
[![GitHub](https://img.shields.io/github/license/oslabs-beta/reactime)](https://github.com/oslabs-beta/reactime)
4-
[![Build Status](https://secure.travis-ci.org/oslabs-beta/reactime.svg?branch=master)](https://travis-ci.com/oslabs-beta/reactime)
8+
[![Build Status](https://travis-ci.com/oslabs-beta/reactime.svg?branch=master)](https://travis-ci.com/oslabs-beta/reactime)
59
[![npm version](https://badge.fury.io/js/reactime.svg)](http://badge.fury.io/js/reactime)
610
[![Dependencies](https://david-dm.org/oslabs-beta/reactime.svg)](https://david-dm.org/oslabs-beta/reactime#info=dependencies)
711
[![DevDependencies](https://david-dm.org/oslabs-beta/reactime/dev-status.svg)](https://david-dm.org/oslabs-beta/reactime?type=dev)
@@ -10,17 +14,21 @@
1014
[![NPM](https://nodei.co/npm/reactime.png)](https://nodei.co/npm/reactime/)
1115

1216
<p align="center">
13-
<img src="demo2.gif" alt="Demo of Reactime" style="width: 55%">
17+
<img src="demo.gif" alt="Demo of Reactime" style="width: 55%">
1418
</p>
1519

16-
A debugging tool for React. Records state whenever state is changed and allows user to jump to any previous recorded state.
20+
Reactime is a debugging tool for React developers. It records state whenever state is changed and allows user to jump to any previous recorded state.
21+
22+
One important thing to note. This devtool is for React apps using only stateful components and prop drilling. If you're using Redux, Hooks, Context, or functional components, this devtool will not function on your app.
23+
24+
Another thing is that this library does not work well when mixing React with direct DOM manipulation. Since DOM manipulation doesn't change any React state, this library cannot record or even detect that change. Of course, you should be avoiding mixing the two in the first place.
1725

1826
Two parts are needed for this tool to function. The <a href="https://chrome.google.com/webstore/detail/react-time-travel/cgibknllccemdnfhfpmjhffpjfeidjga">chrome extension</a> must be installed, and the NPM package must be installed and used in the React code.
1927

2028
After successfully installing the chrome extension, you can test Reactime functionalities in the demo repositories below.
2129

2230
- <a href="http://reactime-demo1.us-east-1.elasticbeanstalk.com/">Calculator</a>
23-
- <a href="http://reactime-demo2.us-east-1.elasticbeanstalk.com/"> Bitcoin Price Index</a>
31+
- <a href="http://reactime-demo2.us-east-1.elasticbeanstalk.com/">Bitcoin Price Index</a>
2432

2533
## Installing
2634

@@ -38,7 +46,7 @@ npm i reactime
3846
const reactime = require('reactime');
3947
4048
const rootContainer = document.getElementById('root');
41-
ReactDom.render(<App />, rootContainer);
49+
ReactDOM.render(<App />, rootContainer);
4250
4351
reactime(rootContainer);
4452
```
@@ -63,7 +71,7 @@ You can click on a snapshot to view your app's state. State can be visualized in
6371

6472
### Jumping
6573

66-
Jumping is the most important feature of all. It allows you to jump to any previous recorded snapshots. Hitting the jump button on any snapshot will change the DOM by setting their state. One important thing to note is that this library does not work well when mixing React with direct DOM manipulation. Since DOM manipulation doesn't change any React state, this library cannot record or even detect that change. Of course, you should be avoiding mixing the two in the first place.
74+
Jumping is the most important feature of all. It allows you to jump to any previous recorded snapshots. Hitting the jump button on any snapshot will change the DOM by setting their state.
6775

6876
### Others
6977

0 commit comments

Comments
 (0)