-
-
Notifications
You must be signed in to change notification settings - Fork 201
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from lind-tania/reactime7
ReadMe update
- Loading branch information
Showing
5 changed files
with
324 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,138 @@ | ||
<p align="center"> | ||
<img src ="./assets/readme-logo-300-no-version.png" width="300"/> | ||
</p> | ||
<h1 align="center"> | ||
React Performance Tool | ||
|
||
<br>Nominated for the Productivity Booster award | ||
<br><a href="https://osawards.com/react/">React Open Source Awards 2020</a> | ||
</h1> | ||
|
||
|
||
[![GitHub](https://img.shields.io/github/license/oslabs-beta/reactime)](https://github.com/oslabs-beta/reactime) [![Build Status](https://travis-ci.com/oslabs-beta/reactime.svg?branch=master)](https://travis-ci.com/oslabs-beta/reactime) [![npm version](https://badge.fury.io/js/reactime.svg)](http://badge.fury.io/js/reactime) ![BabelPresetPrefs](https://img.shields.io/badge/babel%20preset-airbnb-ff69b4) ![LintPrefs](https://img.shields.io/badge/linted%20with-eslint-blueviolet) | ||
|
||
|
||
<p align="center"> | ||
<img src="./assets/reactime7.gif" /> | ||
</p> | ||
|
||
<b>Reactime</b> is a performance and debugging tool for React developers. It records a snapshot whenever a target application's state is changed and allows the user to jump to any previously recorded state. | ||
|
||
Currently, Reactime supports React apps using stateful components and Hooks, with beta support for Recoil and Context API. | ||
|
||
<b>Reactime version 7.0</b> beta can help you to avoid unnecessary re-renders. Identifying wasted renders in your React applications is the perfect start to identifying most performance issues. | ||
Reactime 7.0 fixes previous version bugs and incorporates improved visualizations for component relationships. Reactime 7.0 includes expanded [typedoc](https://typedoc.org/api/) documentation for developers looking to contribute to the source code. | ||
|
||
After installing Reactime, you can test its functionalities with your React application in development mode. | ||
|
||
Please note, the time jumping feature will ONLY work when your application is running in development mode. In production mode, you are able to view your application’s component map but no additional features. | ||
## <b>Installation</b> | ||
|
||
To get started, install the Reactime [extension](https://chrome.google.com/webstore/detail/reactime/cgibknllccemdnfhfpmjhffpjfeidjga) from Chrome Web Store. | ||
|
||
NOTE: The React Developer Tools [extension](https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) is also required for Reactime to run, if you do not already have it installed on your browser. | ||
|
||
### <b>Alternative Installation</b> | ||
Use `src/extension/build/build.zip` for manual installation in [Developer mode](https://developer.chrome.com/extensions/faq#faq-dev-01). Turn on 'Allow access to file URLs' in extension details page if testing locally. | ||
|
||
|
||
## <b>How to Use</b> | ||
|
||
After installing the Chrome extension, just open up your project in the browser. | ||
|
||
Then open up your Chrome DevTools and navigate to the Reactime panel. | ||
|
||
## <b>Troubleshooting</b> | ||
|
||
### <b>Why is Reactime telling me that no React application is found?</b> | ||
Reactime initially runs using the dev tools global hook from the Chrome API. It takes time for Chrome to load this. Try refreshing your application a couple times until you see Reactime running. | ||
|
||
### <b>There is a black screen instead of the Reactime extension</b> | ||
Try refreshing the application you want to test and refresh the DevTools by clicking the right mouse button “Reload frame”. | ||
|
||
### <b>I found a bug in Reactime</b> | ||
Reactime is an open source project, and we’d really appreciate your help with improving user experience. Please, create a pull request (or issue) to propose and collaborate on changes to a repository. | ||
|
||
## <b>Features</b> | ||
|
||
### Re-render Optimization | ||
One of the most common issues that affects performance in React is unnecessary render cycles. This problem can be fixed by checking your renders in the Performance tab in Chrome DevTools under the Reactime panel. | ||
### Recording | ||
|
||
Whenever state is changed (whenever setState, useState 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 Component Graph, JSON Tree, or Performance Graph. Snapshots can be diffed with the previous snapshot, which can be viewed in Diff mode. | ||
|
||
### Jumping | ||
|
||
Using the actions sidebar, a user can jump to any previous recorded snapshots. Hitting the jump button on any snapshot will allow a user to view state data at any point in the history of the target application. | ||
|
||
### TypeScript Support | ||
|
||
Reactime offers beta support for TypeScript applications using stateful class components and functional components. Further testing and development is required for custom hooks, Context API, and Concurrent Mode. | ||
|
||
### Documentation | ||
|
||
After cloning this repository, developers can simply run `npm run docs` at the root level and serve the dynamically generated `/docs/index.html` file on a browser. Doing so will provide a readable, extensible, and interactive GUI view of the structure and interfaces of the codebase. | ||
|
||
### <b>Additional Features</b> | ||
|
||
- identifying unnecessary re-renders | ||
- hover functionality to view tooltip details on state visualizations | ||
- ability to pan and zoom on state visualizations | ||
- a dropdown to support development of projects on multiple tabs | ||
- a slider to move through snapshots quickly | ||
- a play button to move through snapshots automatically | ||
- a lock button, which stops recording each snapshot | ||
- a persist button to keep snapshots upon refresh (handy when changing code and debugging) | ||
- download/upload the current snapshots in memory | ||
- declarative titles in the actions sidebar | ||
|
||
## <b>Read More</b> | ||
- [Time-Travel State with Reactime](https://medium.com/better-programming/time-traveling-state-with-reactime-6-0-53fdc3ae2a20) | ||
- [React Fiber and Reactime](https://medium.com/@aquinojardim/react-fiber-reactime-4-0-f200f02e7fa8) | ||
- [Meet Reactime - a time-traveling State Debugger for React](https://medium.com/@yujinkay/meet-reactime-a-time-traveling-state-debugger-for-react-24f0fce96802) | ||
- [Deep in Weeds with Reactime, Concurrent React_fiberRoot, and Browser History Caching](https://itnext.io/deep-in-the-weeds-with-reactime-concurrent-react-fiberroot-and-browser-history-caching-7ce9d7300abb) | ||
|
||
## <b>Authors</b> | ||
- **Becca Viner** - [@rtviner](https://github.com/rtviner) | ||
- **Caitlin Chan** - [@caitlinchan23](https://github.com/caitlinchan23) | ||
- **Kim Mai Nguyen** - [@Nkmai](https://github.com/Nkmai) | ||
- **Tania Lind** - [@lind-tania](https://github.com/lind-tania) | ||
- **Alex Landeros** - [@AlexanderLanderos](https://github.com/AlexanderLanderos) | ||
- **Chris Guizzetti** - [@guizzettic](https://github.com/guizzettic) | ||
- **Jason Victor** - [@theqwertypusher](https://github.com/Theqwertypusher) | ||
- **Sanjay Lavingia** - [@sanjaylavingia](https://github.com/sanjaylavingia) | ||
- **Vincent Nguyen** - [@guizzettic](https://github.com/VNguyenCode) | ||
- **Haejin Jo** - [@haejinjo](https://github.com/haejinjo) | ||
- **Hien Nguyen** - [@hienqn](https://github.com/hienqn) | ||
- **Jack Crish** - [@JackC27](https://github.com/JackC27) | ||
- **Kevin Fey** - [@kevinfey](https://github.com/kevinfey) | ||
- **Carlos Perez** - [@crperezt](https://github.com/crperezt) | ||
- **Edwin Menendez** - [@edwinjmenendez](https://github.com/edwinjmenendez) | ||
- **Gabriela Jardim Aquino** - [@aquinojardim](https://github.com/aquinojardim) | ||
- **Greg Panciera** - [@gpanciera](https://github.com/gpanciera) | ||
- **Nathanael Wa Mwenze** - [@nmwenz90](https://github.com/nmwenz90) | ||
- **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) | ||
- **Ruth Anam** - [@peachiecodes](https://github.com/peachiecodes) | ||
- **David Chai** - [@davidchaidev](https://github.com/davidchai717) | ||
- **Yujin Kang** - [@yujinkay](https://github.com/yujinkay) | ||
- **Andy Wong** - [@andywongdev](https://github.com/andywongdev) | ||
- **Chris Flannery** - [@chriswillsflannery](https://github.com/chriswillsflannery) | ||
- **Rajeeb Banstola** - [@rajeebthegreat](https://github.com/rajeebthegreat) | ||
- **Prasanna Malla** - [@prasmalla](https://github.com/prasmalla) | ||
- **Rocky Lin** - [@rocky9413](https://github.com/rocky9413) | ||
- **Abaas Khorrami** - [@dubalol](https://github.com/dubalol) | ||
- **Ergi Shehu** - [@Ergi516](https://github.com/ergi516) | ||
- **Raymond Kwan** - [@rkwn](https://github.com/rkwn) | ||
- **Joshua Howard** - [@Joshua-Howard](https://github.com/joshua-howard) | ||
|
||
## <b>License </b> | ||
|
||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.