|
2 | 2 | <img src ="./assets/readme-logo-300-no-version.png" width="300"/> |
3 | 3 | </p> |
4 | 4 | <h1 align="center"> |
5 | | - State Debugger for React |
| 5 | + React Performance Tool |
6 | 6 |
|
7 | 7 | <br>Nominated for the Productivity Booster award |
8 | | - <br><a href="https://osawards.com/react/">👑 React Open Source Awards 2020 👑</a> |
| 8 | + <br><a href="https://osawards.com/react/">React Open Source Awards 2020</a> |
9 | 9 | </h1> |
10 | 10 |
|
11 | 11 |
|
12 | | -[](https://github.com/oslabs-beta/reactime) [](https://travis-ci.com/oslabs-beta/reactime) [](http://badge.fury.io/js/reactime) [](https://snyk.io/test/github/oslabs-beta/reactime) |
| 12 | +[](https://github.com/oslabs-beta/reactime) [](https://travis-ci.com/oslabs-beta/reactime) [](http://badge.fury.io/js/reactime)   |
| 13 | + |
| 14 | +<h3 align="center"> |
| 15 | +<br> |
| 16 | + <a href="./README.rus.md">РУССКАЯ ВЕРСИЯ</a> <a href="./README.fr.md">VERSION FRANÇAISE</a> |
| 17 | + <br> |
| 18 | +</h3> |
| 19 | +<br> |
13 | 20 |
|
14 | 21 | <p align="center"> |
15 | | -<img src="./assets/react-calculator-demo.gif" /> |
16 | | -<img src="./assets/recoil-todo-demo.gif" /> |
| 22 | +<img src="./assets/reactime7.gif" /> |
17 | 23 | </p> |
18 | 24 |
|
19 | | -<b>Reactime</b> is a 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. |
| 25 | +<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. |
20 | 26 |
|
21 | 27 | Currently, Reactime supports React apps using stateful components and Hooks, with beta support for Recoil and Context API. |
22 | 28 |
|
23 | | -Reactime verision 6.0 beta extends the core functionality by including support for [Recoil](https://recoiljs.org/). The latest release incorporates additional visualizations for component relationships as well as atom-selector relationships for Recoil applications. Reactime 6.0 includes expanded [typedoc](https://typedoc.org/api/) documentation for developers looking to contribute to the source code. |
24 | | - |
25 | | -After installing Reactime, you can test its functionalities with the following demo repositories: |
| 29 | +<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. |
| 30 | +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. |
26 | 31 |
|
27 | | -- [Vanilla React Calculator](https://joshua0308.github.io/calculator/) |
28 | | -- [Bitcoin Price Index](http://reactime-demo2.us-east-1.elasticbeanstalk.com) |
29 | | -- [Recoil Design Tool](https://github.com/jacques-blom/recoil-design-tool) |
30 | | -- [Recoil Todo List](https://github.com/kevinfey/recoilTest) |
| 32 | +After installing Reactime, you can test its functionalities with your React application in development mode. |
31 | 33 |
|
| 34 | +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. |
32 | 35 | ## <b>Installation</b> |
33 | 36 |
|
34 | 37 | To get started, install the Reactime [extension](https://chrome.google.com/webstore/detail/reactime/cgibknllccemdnfhfpmjhffpjfeidjga) from Chrome Web Store. |
35 | 38 |
|
36 | | -### Alternative Installation |
| 39 | +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. |
| 40 | + |
| 41 | +### <b>Alternative Installation</b> |
37 | 42 | 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. |
38 | 43 |
|
39 | | -*** for depracated installation steps, [click here](https://github.com/open-source-labs/reactime/blob/master/readme-OldVersion.md) *** |
40 | 44 |
|
41 | 45 | ## <b>How to Use</b> |
42 | 46 |
|
43 | 47 | After installing the Chrome extension, just open up your project in the browser. |
44 | 48 |
|
45 | 49 | Then open up your Chrome DevTools and navigate to the Reactime panel. |
46 | 50 |
|
| 51 | +## <b>Troubleshooting</b> |
| 52 | + |
| 53 | +### <b>Why is Reactime telling me that no React application is found?</b> |
| 54 | +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. |
| 55 | + |
| 56 | +### <b>There is a black screen instead of the Reactime extension</b> |
| 57 | +Try refreshing the application you want to test and refresh the DevTools by clicking the right mouse button “Reload frame”. |
| 58 | + |
| 59 | +### <b>I found a bug in Reactime</b> |
| 60 | +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. |
| 61 | + |
47 | 62 | ## <b>Features</b> |
48 | 63 |
|
| 64 | +### Re-render Optimization |
| 65 | +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. |
49 | 66 | ### Recording |
50 | 67 |
|
51 | | -Whenever state is changed (whenever setState, useState, or useRecoilState 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. |
| 68 | +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. |
52 | 69 |
|
53 | 70 | ### Viewing |
54 | 71 |
|
55 | | -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. In a Recoil application, flow of data from atoms to components is visualized in the Relationships tab. Also, snapshots can be diffed with the previous snapshot, which can be viewed in Diff mode. |
| 72 | +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. |
56 | 73 |
|
57 | 74 | ### Jumping |
58 | 75 |
|
59 | 76 | 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. |
60 | 77 |
|
61 | 78 | ### TypeScript Support |
62 | 79 |
|
63 | | -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. |
| 80 | +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. |
64 | 81 |
|
65 | 82 | ### Documentation |
66 | 83 |
|
67 | 84 | 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. |
68 | 85 |
|
69 | | -### Additional Features |
| 86 | +### <b>Additional Features</b> |
70 | 87 |
|
| 88 | +- identifying unnecessary re-renders |
71 | 89 | - hover functionality to view tooltip details on state visualizations |
72 | 90 | - ability to pan and zoom on state visualizations |
73 | 91 | - a dropdown to support development of projects on multiple tabs |
74 | 92 | - a slider to move through snapshots quickly |
75 | 93 | - a play button to move through snapshots automatically |
76 | | -- a pause button, which stops recording each snapshot |
77 | | -- a lock button to freeze the DOM in place. setState will lose all functionality while the extension is locked |
| 94 | +- a lock button, which stops recording each snapshot |
78 | 95 | - a persist button to keep snapshots upon refresh (handy when changing code and debugging) |
79 | | -- export/import the current snapshots in memory |
| 96 | +- download/upload the current snapshots in memory |
80 | 97 | - declarative titles in the actions sidebar |
81 | 98 |
|
| 99 | +## <b>Read More</b> |
| 100 | +- [Time-Travel State with Reactime](https://medium.com/better-programming/time-traveling-state-with-reactime-6-0-53fdc3ae2a20) |
| 101 | +- [React Fiber and Reactime](https://medium.com/@aquinojardim/react-fiber-reactime-4-0-f200f02e7fa8) |
| 102 | +- [Meet Reactime - a time-traveling State Debugger for React](https://medium.com/@yujinkay/meet-reactime-a-time-traveling-state-debugger-for-react-24f0fce96802) |
| 103 | +- [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) |
| 104 | + |
82 | 105 | ## <b>Authors</b> |
| 106 | +- **Becca Viner** - [@rtviner](https://github.com/rtviner) |
| 107 | +- **Caitlin Chan** - [@caitlinchan23](https://github.com/caitlinchan23) |
| 108 | +- **Kim Mai Nguyen** - [@Nkmai](https://github.com/Nkmai) |
| 109 | +- **Tania Lind** - [@lind-tania](https://github.com/lind-tania) |
83 | 110 | - **Alex Landeros** - [@AlexanderLanderos](https://github.com/AlexanderLanderos) |
84 | 111 | - **Chris Guizzetti** - [@guizzettic](https://github.com/guizzettic) |
85 | 112 | - **Jason Victor** - [@theqwertypusher](https://github.com/Theqwertypusher) |
|
0 commit comments