|
1 | | -# VueQueryRewind |
| 1 | +<a id="readme-top"></a> |
| 2 | + |
| 3 | +<p align="center"> |
| 4 | + <img src="./assets/icon.png" alt="Logo" width="250"/> |
| 5 | +</p> |
| 6 | + |
| 7 | +# Technologies |
| 8 | + |
| 9 | +[](https://www.javascript.com/) |
| 10 | +[](https://www.typescriptlang.org/) |
| 11 | +[](https://reactjs.org/) |
| 12 | +[](https://html.com/html5/) |
| 13 | +[](https://webpack.js.org/) |
| 14 | +[](https://d3js.org/) |
| 15 | +[](https://eslint.org/) |
| 16 | +[](https://mui.com/) |
| 17 | +[](https://jestjs.io/) |
| 18 | +[](https://babeljs.io/) |
| 19 | + |
| 20 | +# Overview |
| 21 | + |
| 22 | +Vue Query Rewind introduces a powerful DevTool extension designed to work in conjunction with React Query's built-in DevTools in order to optimize time-traveling through state changes in an application. This open-source extension is tailored to enhance the debugging experience for React Query users, allowing them to explore state changes and component relationships with ease. |
| 23 | + |
| 24 | +# Getting Started |
| 25 | + |
| 26 | +## Prerequisites |
| 27 | + |
| 28 | +1. React Query installed and in use in your application. |
| 29 | + |
| 30 | +2. Install RQRewind Chrome Extension. |
| 31 | + |
| 32 | + <!-- _link / picture of Extension in Chrome Store_ --> |
| 33 | + |
| 34 | +## Installation |
| 35 | + |
| 36 | +1. Download npm package into your application as a dev dependency. |
| 37 | + |
| 38 | + ```sh |
| 39 | + npm i --save-dev react-query-rewind |
| 40 | + ``` |
| 41 | + |
| 42 | +2. Import the ReactQueryRewind component into the root of your applicaiton. |
| 43 | + |
| 44 | + _picture of importing the component_ |
| 45 | + |
| 46 | + ```javascript |
| 47 | + import ReactQueryRewind from 'react-query-rewind'; |
| 48 | + ``` |
| 49 | + |
| 50 | +3. Place ReactQueryRewind next to the root of your application inside the QueryClientProvider component. |
| 51 | + |
| 52 | + ```javascript |
| 53 | + ReactDOM.createRoot(document.getElementById('root')!).render( |
| 54 | + <QueryClientProvider client={queryClient}> |
| 55 | + <App /> |
| 56 | + <ReactQueryRewind /> |
| 57 | + </QueryClientProvider> |
| 58 | + ); |
| 59 | + ``` |
| 60 | + |
| 61 | +4. Open the Chrome DevTool Extension and start coding! |
| 62 | + |
| 63 | + <p align="left"> |
| 64 | + <img src="./assets/chrome-devtool.png" alt="Component Placement" width="600"/> |
| 65 | + </p> |
| 66 | + |
| 67 | +# Features |
| 68 | + |
| 69 | +- <b>Query States: </b>Upon opening RQRewind in Chrome Dev Tools, you will see the Queries tab open with a drop down menu listing the query keys of all the incoming queries. Select the queries that you want to monitor, make changes on the web app, and the changes of query states will be logged as reflected by the growing number above the play bar. Use the play bar to navigate to a particular state snapshot that you would like to inspect. |
| 70 | + |
| 71 | +<p align= "center"><img src= "./assets/query-states.gif" width= '800' style= "margin-top: 1em; margin-bottom: 1em;"></p > |
| 72 | + |
| 73 | +- <b>State Diff: </b>Toggle on the Diff button to see state changes between each snapshot highlighted. Turn on the switch on top of the page to show only parts of the state that are changed. |
| 74 | + |
| 75 | +<p align= "center"><img src= "./assets/state-diff.gif" width= '800' style= "margin-top: 1em; margin-bottom: 1em;"></p > |
| 76 | + |
| 77 | +- <b>Live UI Change: </b>As you review the state change history, there is also the option to turn on the time travel mode by clicking on the clock icon button. Under time travel mode, when visiting a logged state snapshot on RQRewindl, the UI of the app will change accordingly. Turn off time travel mode for RQRewind to continue logging future state changes. |
| 78 | + |
| 79 | +<p align= "center"><img src= "./assets/UI-change.gif" width= '800' style= "margin-top: 1em; margin-bottom: 1em;"></p > |
| 80 | + |
| 81 | +- <b>Component Tree: </b> Click on the Component Tree tab and turn on the Start Profiling switch. Click on any component on the app, and view the component tree that is rendered on the dev tools panel. |
| 82 | + |
| 83 | +<p align= "center"><img src= "./assets/component-tree.gif" width= '800' style= "margin-top: 1em; margin-bottom: 1em;"></p > |
| 84 | + |
| 85 | +# Contact Information |
| 86 | + |
| 87 | +Austin Cavanagh - [GitHub](https://github.com/austin-cavanagh) - [LinkedIn](https://www.linkedin.com/in/austincavanagh/) - [email protected] |
| 88 | + |
| 89 | +Emma Teering - [GitHub](https://github.com/eteering) - [LinkedIn](https://www.linkedin.com/in/emma-teering/) - [email protected] |
| 90 | + |
| 91 | +John Dunn - [GitHub](https://github.com/johnwdunn20) - [LinkedIn](https://www.linkedin.com/in/johnwdunn/) - [email protected] |
| 92 | + |
| 93 | +Rui Fan - [GitHub](https://github.com/ruifan-IU) - [LinkedIn](https://www.linkedin.com/in/rui-fan-868231299/) - [email protected] |
| 94 | + |
| 95 | +# Links |
| 96 | + |
| 97 | +[](https://medium.com/@teeringe/react-query-rewind-time-travel-debugging-made-simple-46aaeeafd497) |
| 98 | +[](https://www.linkedin.com/company/react-query-rewind/) |
| 99 | + |
| 100 | +Project Link: [React Query Rewind](https://github.com/oslabs-beta/react-query-rewind-chrome) |
| 101 | + |
| 102 | +# License |
| 103 | + |
| 104 | +_MIT Link_ |
| 105 | + |
| 106 | +<p align="right">(<a href="#readme-top">back to top</a>)</p> |
0 commit comments