Skip to content

Commit

Permalink
changed name from react-time-travel to reactime
Browse files Browse the repository at this point in the history
  • Loading branch information
rydang committed Aug 14, 2019
1 parent e78fa0a commit f1a10e8
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 30 deletions.
Binary file added package/demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 8 additions & 9 deletions package/package.json
Original file line number Diff line number Diff line change
@@ -1,27 +1,26 @@
{
"name": "react-time-travel",
"name": "reactime",
"version": "1.1.1",
"description": "A library that helps debug React by memorizing the state of components with every render.",
"main": "index.js",
"repository": {
"type": "git",
"url": "https://github.com/oslabs-beta/react-time-travel"
"url": "https://github.com/oslabs-beta/reactime"
},
"scripts": {
"test": "echo \"Error: no test specified\""
},
"peerDependencies": {
"react": ">= 16.8"
"react": "~16.0.0",
"react-dom": "~16.0.0"
},
"keywords": [
"react",
"time",
"travel",
"time-travel",
"timetravel",
"react-time-travel",
"react-timetravel"
"time travel",
"reactime",
"react devtool"
],
"author": "Bryan Lee, Josh Kim, Ryan Dang, Sierra Swaby",
"license": "ISC"
"license": "MIT"
}
57 changes: 36 additions & 21 deletions package/readme.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,35 @@
# React-Time-Travel
# Reactime

![GitHub](https://img.shields.io/github/license/oslabs-beta/reactime)
![Travis (.com) branch](https://img.shields.io/travis/com/oslabs-beta/reactime/dev?label=dev%20build)
![Travis (.com) branch](https://img.shields.io/travis/com/oslabs-beta/reactime/master?label=master%20build)
![npm](https://img.shields.io/npm/v/reactime?color=green)
![David](https://img.shields.io/david/oslabs-beta/reactime)
![DevDependencies](https://img.shields.io/david/dev/oslabs-beta/reactime.svg)
![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/oslabs-beta/reactime)

<p align="center">
<img src="demo.gif" alt="Demo of Reactime">
</p>

A debugging tool for React. Records state whenever state is changed and allows user to jump to any previous recorded state.

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.

## Installing

1. Download the Chrome extension from Chrome Web Store.
1. Download the [extension](https://chrome.google.com/webstore/detail/reactime/cgibknllccemdnfhfpmjhffpjfeidjga) from Chrome Web Store.

2. Install the [npm package](https://www.npmjs.com/package/reactime) in your code.

2. Install the [npm package](https://www.npmjs.com/package/react-time-travel) in your code.
```
npm i react-time-travel
npm i reactime
```

3. Call the library method on your root container after rendering your App.

```
const reactTimeTravel = require('react-time-travel');
const reactTimeTravel = require('reactime');
const rootContainer = document.getElementById('root');
ReactDom.render(<App />, rootContainer);
Expand All @@ -27,19 +41,19 @@ reactTimeTravel(rootContainer);

## How to Use

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

Then open up your Chrome DevTools. There'll be a new tab called React-Time-Travel.
Then open up your Chrome DevTools. There'll be a new tab called reactime.

## Features

### Recording

Whenever state is changed (whenever setState is called), this extension will create a snapshot of the current state tree and record it. Each snapshot will be displayed in Chrome DevTools under the React-Time-Travel panel.
Whenever state is changed (whenever setState is called), this extension will create a snapshot of the current state tree and record it. Each snapshot will be displayed in Chrome DevTools under the Reactime panel.

### Viewing

You can click on a snapshot to view your app's state. State can be visualized in a JSON or a tree.
You can click on a snapshot to view your app's state. State can be visualized in a JSON or a tree.

The selected snapshot can also be diffed/compared with the current dom.

Expand All @@ -49,21 +63,22 @@ The most important feature of all. Jumping to any previous recorded snapshot. Hi

### Others

Other handy features include:
* multiple tabs support
* a slider to move through snapshots quickly
* a play button to move through snapshots automatically
* a pause which button stops recording each snapshot
* a lock button to freeze the DOM in place. setState will lose all functionality while the extension is locked
* a persist button to keep snapshots upon refresh. handy when changing code and debugging
* export/import the current snapshots in memory
Other handy features include:

- multiple tabs support
- a slider to move through snapshots quickly
- a play button to move through snapshots automatically
- a pause which button stops recording each snapshot
- a lock button to freeze the DOM in place. setState will lose all functionality while the extension is locked
- a persist button to keep snapshots upon refresh. handy when changing code and debugging
- export/import the current snapshots in memory

## Authors

* **Ryan Dang** - [@rydang](https://github.com/rydang)
* **Bryan Lee** - [@mylee1995](https://github.com/mylee1995)
* **Josh Kim** - [@joshua0308](https://github.com/joshua0308)
* **Sierra Swaby** - [@starkspark](https://github.com/starkspark)
- **Ryan Dang** - [@rydang](https://github.com/rydang)
- **Bryan Lee** - [@mylee1995](https://github.com/mylee1995)
- **Josh Kim** - [@joshua0308](https://github.com/joshua0308)
- **Sierra Swaby** - [@starkspark](https://github.com/starkspark)

## License

Expand Down

0 comments on commit f1a10e8

Please sign in to comment.