Coder Social home page Coder Social logo

naylinnpkv / reactmonitor Goto Github PK

View Code? Open in Web Editor NEW

This project forked from react-monitor-2-0/reactmonitor

2.0 0.0 0.0 977 KB

Quickly visualize React's component tree and its performance

License: MIT License

JavaScript 89.16% HTML 1.15% SCSS 9.69%

reactmonitor's Introduction

ReactMonitor

Quickly visualize React's component tree performance for improved onboarding and debugging

What does it do

By using the ReactMonitor Chrome DevTool, beginning and experienced developers alike are able to get a visual representation of an existing codebase that they are working on. Built with React, this tool will dynamically traverse the fiber root object behind the scenes, displaying state, props, render times and the type of components on the page.

readmeDemo

How to install and run

To be able to use the application, users can:

  • Download the 'ReactMonitor' Google Chrome extension from The Chrome Web Store

  • Navigate to the domain of your React application that you will be running React Monitor on

  • Open your Chrome Developer Tools and select React Monitor

  • You are now able to view state changes on your application in real time!

Method 2: Clone this repository

  • in the root directory of the clone run npm build

  • in Chrome -> extensions, enable developer mode

  • select add new unpackaged extension

  • in the folder selection window, select the dist folder

Requirements:

  • reactmonitor will only search in children (depth 1) of <body> for the HTML element where a React DOM is rendered only (issue #10)

  • app to be tested needs to include React versions that use Fiber Tree (such as React 16)

  • app to be tested need to be in a development build of React or a Production build with React Profiler enabled

Contributing

As an open-sourced project, ReactMonitor gladly accepts help whenever possible. If you have suggestions for improvements or run into any bugs, please feel free to open a github issue after checking whether no such issue has been filed yet. When you file a github issue, please include the following information:

Description

Steps to Reproduce
1.
2.
3.
Expected behavior:
Actual behavior:
Reproduces how often:
Versions: x.x
Additional Information:

Authors

Rudo Hengst: @RudoH
Lia Pham: @lpham598
Tommy Han: @simple-sifu
Nay Linn: @naylinnpkv
Hamoud Ebnou: @Ebnouhamoud
Dan Bitsmith: @bitsmith-ny19
Philip Rodrigues: @Malvado996

License

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

reactmonitor's People

Contributors

rudoh avatar simple-sifu avatar lpham598 avatar ebnouhamoud avatar naylinnpkv avatar malvado996 avatar

Stargazers

Steve Budarz avatar  avatar

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.