Git Product home page Git Product logo

realize's Introduction

Logo

Realize For React

As React applications scale, it becomes more difficult to track state and to have a holistic overview of the component hierarchy. Realize is a tool to help developers visualize the structure and state flow of their React applications, especially when they are growing in scale and complexity. It currently supports React v.16.8.

Logo

👩‍💻 How to use it

  1. Install the extension from the Firefox store & Chrome store
  2. Navigate to your React website
  3. Open the dev tools window and select the Realize Panel
  4. Trigger a state change to see the component tree populate

Prerequisites

  • Realize requires React Dev Tools to be installed before use.
  • Realize is best used on non-deployed applications. This uglification of deployed websites makes the component structure pretty unreadable.

🔥 Key Features

Zoom & Pan - Hold down shift to enable dragging and zooming on the tree (to recenter just click the center button)
Component Focus - Click on a node to view state, props and children in the right and panel
State Flow - Click the 'state' toggle to show state flow on the tree. Stateful components have blue nodes and state flow is show by blue links
Search and Highlight - Enter a component name in the search bar to see all matching nodes pulsate

💻 Installing locally

  1. Clone the repo onto your computer git clone https://github.com/oslabs-beta/Realize
  2. Run npm i from inside the root directory
  3. Run npm build
  4. Load the extension from the build/extension folder into your browser of choice:
          For Firefox, navigate to about:debugging#/runtime/this-firefox and click Load Temporary Addon
          For Chrome, navigate to chrome://extensions/ toggle developer mode on and click Load Unpacked
  5. Follow steps 2 onwards from the 'How to use it' section

Authors

Fan Shao - Github | LinkedIn
Harry Clifford - Github | LinkedIn
Henry Black - Github | LinkedIn
Horatiu Mitrea - Github | LinkedIn

Contact

You can contact us personally through our LinkedIn accounts (links above) or as a team via [email protected]

Contributing

We would love for you to test out our extensions and submit any issues you encounter. Feel free to fork to your own repo and submit PRs. Some features we would like to add:

  1. Performance data on render times
  2. Expanding/collapsing nodes
  3. Autocomplete on search

License

This project is licensed under the MIT License - see the LICENSE file for details

realize's People

Contributors

blackhaj avatar dependabot[bot] avatar fan-shao avatar hmitrea avatar hpwclifford avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

realize's Issues

not working

FYI:

I just get freeze on chrome and no result
No result on firefox too

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.