Skip to content

Commit

Permalink
Merge pull request #55 from oslabs-beta/john/movies
Browse files Browse the repository at this point in the history
John/movies
  • Loading branch information
austin-cavanagh authored May 8, 2024
2 parents df799c4 + cfd2aa7 commit a4ed265
Show file tree
Hide file tree
Showing 18 changed files with 44 additions and 315 deletions.
29 changes: 0 additions & 29 deletions .github/workflows/deployChrome.yml

This file was deleted.

31 changes: 0 additions & 31 deletions .github/workflows/npmPublish.yml

This file was deleted.

53 changes: 8 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ React Query Rewind introduces a powerful DevTool extension designed to work in c
_picture of importing the component_

```javascript
import ReactQueryRewind from 'react-query-rewind';
import ReactQueryRewind from "react-query-rewind";
```

3. Place ReactQueryRewind next to the root of your application inside the QueryClientProvider component.
Expand All @@ -61,26 +61,26 @@ React Query Rewind introduces a powerful DevTool extension designed to work in c
4. Open the Chrome DevTool Extension and start coding!

<p align="left">
<img src="./assets/chrome-devtool.png" alt="Component Placement" width="600"/>
<img src="https://i.imgur.com/xTEPI20.png" alt="Component Placement" width="600"/>
</p>

# Features

- <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.

<p align="center"><img src="./assets/query-states.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>
<p align="center"><img src="https://i.imgur.com/g8KrqAg.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>

- <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.

<p align="center"><img src="./assets/state-diff.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>
<p align="center"><img src="https://i.imgur.com/a8KAgXZ.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>

- <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.

<p align="center"><img src="./assets/UI-change.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>
<p align="center"><img src="https://i.imgur.com/AZ3QGuf.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>

- <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.

<p align="center"><img src="./assets/component-tree.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>
<p align="center"><img src="https://i.imgur.com/qa5UJTW.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>

# Contributing

Expand Down Expand Up @@ -111,43 +111,6 @@ Rui Fan - [GitHub](https://github.com/ruifan-IU) - [LinkedIn](https://www.linked
Project Link: [React Query Rewind](https://github.com/oslabs-beta/react-query-rewind-chrome)
# License
[MIT](https://www.mit.edu/~amini/LICENSE.md)
_MIT Link_
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- TABLE OF CONTENTS -->
<!-- <details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details> -->
<!-- <p align="right">(<a href="#readme-top">back to top</a>)</p> -->
<!-- <a name="website" href="ARE WE GONNA HAVE A WEBSITE">Website</a> -->
<!-- [![Contributors](https://img.shields.io/github/contributors/oslabs-beta/react-query-rewind-chrome.svg?style=for-the-badge)](https://github.com/oslabs-beta/react-query-rewind-chrome/graphs/contributors)
[![Forks](https://img.shields.io/github/forks/oslabs-beta/react-query-rewind-chrome.svg?style=for-the-badge)](https://github.com/oslabs-beta/react-query-rewind-chrome/forks)
[![Stargazers](https://img.shields.io/github/stars/oslabs-beta/react-query-rewind-chrome.svg?style=for-the-badge)](https://github.com/oslabs-beta/react-query-rewind-chrome/stargazers)
[![Issues](https://img.shields.io/github/issues/oslabs-beta/react-query-rewind-chrome.svg?style=for-the-badge)](https://github.com/oslabs-beta/react-query-rewind-chrome/issues)
[![MIT License](https://img.shields.io/github/license/oslabs-beta/react-query-rewind-chrome.svg?style=for-the-badge)](https://github.com/oslabs-beta/react-query-rewind-chrome/blob/main/LICENSE) -->
<p align="right">(<a href="#readme-top">back to top</a>)</p>
1 change: 0 additions & 1 deletion extension/build/background.js

This file was deleted.

1 change: 0 additions & 1 deletion extension/build/content.js

This file was deleted.

13 changes: 0 additions & 13 deletions extension/build/devtools.html

This file was deleted.

1 change: 0 additions & 1 deletion extension/build/devtools.js

This file was deleted.

Binary file removed extension/build/icon.png
Binary file not shown.
1 change: 0 additions & 1 deletion extension/build/index.html

This file was deleted.

75 changes: 0 additions & 75 deletions extension/build/index.js

This file was deleted.

57 changes: 0 additions & 57 deletions extension/build/index.js.LICENSE.txt

This file was deleted.

1 change: 0 additions & 1 deletion extension/build/inject.js

This file was deleted.

35 changes: 0 additions & 35 deletions extension/build/manifest.json

This file was deleted.

11 changes: 0 additions & 11 deletions extension/build/panel.html

This file was deleted.

32 changes: 21 additions & 11 deletions package-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,18 @@ React Query Rewind introduces a powerful DevTool extension designed to work in c

## Installation

1. Download npm package into your application as a dev dependency.
1. Download npm package into your application.

```sh
npm i --save-dev react-query-rewind
npm i react-query-rewind
```

2. Import the ReactQueryRewind component into the root of your applicaiton.

_picture of importing the component_

```javascript
import ReactQueryRewind from 'react-query-rewind';
import ReactQueryRewind from "react-query-rewind";
```

3. Place ReactQueryRewind next to the root of your application inside the QueryClientProvider component.
Expand All @@ -61,26 +61,37 @@ React Query Rewind introduces a powerful DevTool extension designed to work in c
4. Open the Chrome DevTool Extension and start coding!

<p align="left">
<img src="./assets/chrome-devtool.png" alt="Component Placement" width="600"/>
<img src="https://i.imgur.com/xTEPI20.png" alt="Component Placement" width="600"/>
</p>

# Features

- <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.

<p align="center"><img src="./assets/query-states.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>
<p align="center"><img src="https://i.imgur.com/g8KrqAg.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>

- <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.

<p align="center"><img src="./assets/state-diff.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>
<p align="center"><img src="https://i.imgur.com/a8KAgXZ.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>

- <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.

<p align="center"><img src="./assets/UI-change.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>
<p align="center"><img src="https://i.imgur.com/AZ3QGuf.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>

- <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.

<p align="center"><img src="./assets/component-tree.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>
<p align="center"><img src="https://i.imgur.com/qa5UJTW.gif" width='800' style="margin-top: 1em; margin-bottom: 1em;"></p>

# Contributing

React Query Rewind values the strength of community involvement. If you're enthusiastic about React Query, time-traveling state, or improving debugging experiences, your contributions are highly appreciated. Whether it's code enhancements, documentation improvements, or innovative feature suggestions, your engagement can play a pivotal role in shaping the future of React Query Rewind. If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
# Contact Information
Expand All @@ -100,7 +111,6 @@ Rui Fan - [GitHub](https://github.com/ruifan-IU) - [LinkedIn](https://www.linked
Project Link: [React Query Rewind](https://github.com/oslabs-beta/react-query-rewind-chrome)
# License
[MIT](https://www.mit.edu/~amini/LICENSE.md)
_MIT Link_

<p align="right">(<a href="#readme-top">back to top</a>)</p>
<p align="right">(<a href="#readme-top">back to top</a>)</p>
2 changes: 1 addition & 1 deletion package-react/example/client/src/components/NavBar.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export default function NavBar() {

return (
<nav className="border-gray-200 dark:bg-gray-800 dark:border-gray-700 border-b-1 border-gray-300 shadow dark:shadow-dark-custom w-full bg-gray-50">
<div className="max-w-screen-lg flex items-center justify-between mx-auto">
<div className="max-w-screen-lg flex items-center justify-between mx-auto ml-4">
<a href="#" className="flex items-center space-x-4 rtl:space-x-reverse">
<svg
xmlns="http://www.w3.org/2000/svg"
Expand Down
8 changes: 7 additions & 1 deletion package-react/example/server/models/sports.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[
{
"text": "Can't believe the 49ers pulled off that comeback! Their defense in the second half was incredible.",
"liked": false,
"liked": true,
"createComment": false,
"timestamp": "Mar 10, 2024",
"username": "Marcus Holloway",
Expand All @@ -12,6 +12,12 @@
"timestamp": "Mar 10, 2024",
"username": "Samuel Drake",
"picture": "https://flowbite.com/docs/images/people/profile-picture-2.jpg"
},
{
"text": "yeah!\n",
"timestamp": "Mar 20, 2024",
"username": "Guest",
"picture": "guest"
}
]
},
Expand Down
Loading

0 comments on commit a4ed265

Please sign in to comment.