Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gossamer-react/lucid

A developer tool for engineers working with React and GraphQL.
https://github.com/gossamer-react/lucid

apollographql chrome chrome-devtools chrome-devtools-extension chrome-extensions devtools graphql graphql-query graphql-tools javascript react react-applications react-developers react-devtools react-state-management

Last synced: about 1 month ago
JSON representation

A developer tool for engineers working with React and GraphQL.

Awesome Lists containing this project

README 

        


  





  




[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Make%20development%20easier%20with%20Lucid.&url=https://github.com/Gossamer-React/Lucid&hashtags=react,graphql,apollographql,javascript,programming,developers,chrome)

![AppVeyor](https://img.shields.io/badge/build-passing-green.svg)

![AppVeyor](https://img.shields.io/badge/License-MIT-blue.svg)



## **Lucid**: *a React-GraphQL developer tool*



Lucid is a Chrome Developer Tool designed to help engineers debug their React-GraphQL applications. 

- Visualize the component hierarchy, state/props data and state changes of your React application

- See your GraphQL schema, queries, and mutations in real-time



## Underlying Technology

### React Tab

Lucid parses through your React app to generate an interactive tree graph representing your __React component hierarchy__, with node-specific __state and props__ data. The tree updates upon each change to the React app's state, and displays a log of __state diffs__ on the left. This is done by creating a persistent data bridge to the user's React application via the Javascript API for WebExtensions' background and content scripts. Lucid injects scripts utilizing React DevTool's Global Hook to recursively traverse through the React DOM each time setState is called, resulting in a tree and a log that each display real-time feedback. Our app itself uses React internally so as the state of your live app changes, the Lucid tree graph will also provide visual feedback of data flow and state changes through the React components immediately.



### GraphQL Tab

Lucid intercepts HTTP requests using Chrome Devtool APIs to display a log of real-time __Apollo client queries and mutations__, along with associated __response__ objects. Lucid also uses GraphQL schema introspection to display __schema__ information from the server. This allows full-stack developers to debug their app from the front-end to the back-end, as requests are generated, responses are returned from the server, and data flows through React components to be rendered in the DOM. 



## Setup

| Install from Chrome Extension Store  | Build your own extension |

| ------------- | ------------- |

| 1. Install React Developer Tools. | 1. Clone the repo and ```npm install``` |

| 2. Install Lucid or __Build your own extension__. | 2. ```npm run build ```|

|3. Restart Chrome Browser. |3. Navigate to chrome://extensions. |

|4. Run your React v16+ application using GraphQL.|4. Click **Load Unpacked** and select your './react-lucid/build' folder.|

|5. Open Chrome Developer Tools (Inspect) and click on the Lucid panel. Trigger a re-render! |



**IMPORTANT:**  Lucid is in *BETA* mode and works best for React v16+ local projects in development environments. 



## How to Use

### GraphQL Tab 

* In the GraphQL panel, a chronological log of API __requests__ is shown on the left. 

* A GraphQL __schema__ of all available types, queries, and mutations is also automatically fetched from the GraphQL server when Lucid is initialized and displayed on the bottom.

* Click each request log to see its associated HTTP __response__. 

 

**NOTE:**  Lucid only listens for HTTP requests while it is open in the Chrome Developer Tool panel. To see any requests that were made upon initial page load, reload your React page after opening Lucid in your Chrome browser. 



![](public/demo-photo-graphql.png) 



### React Tab

* In the React panel is a tree graph representing your application's __component hierarchy__. 

* Hovering over any React Component in the tree displays the __state and props data__ of that component in the top left.

* The __State Diff__ Log tracks changes in state whenever setState() is triggered.

* Filter out specified higher-order components from your tree graph (e.g. Redux, Apollo-GraphQL, and React Router) by clicking the buttons.



![](public/demo-photo-react.png)



## Contributing 



Lucid is currently in beta release. Please let us know about bugs and suggestions at [email protected]. Feel free to fork this repo and submit pull requests! 



## Coming Soon



## Team



Yong-Nicholas Kim (https://github.com/yongnicholaskim)



Nian Liu (https://github.com/nianliu18)



Eterna Tsai (https://github.com/eternalee)



Neyser Zana (https://github.com/neyser95)



## License

MIT