Ecosyste.ms: Awesome

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

https://github.com/RamonGebben/react-perf-tool

[Deprecated] Debug performance of your React application
https://github.com/RamonGebben/react-perf-tool

Last synced: 2 months ago
JSON representation

[Deprecated] Debug performance of your React application

Lists

README 

        
# Deprecated 😞



> As of React 16, react-addons-perf is not supported. Please use your browser’s profiling tools to get insight into which components re-render.



For examples on how to use browsers profiler for performance testing check the [React Docs](https://reactjs.org/docs/optimizing-performance.html#profiling-components-with-the-chrome-performance-tab)



# ReactPerfTool



[![Package Quality](http://npm.packagequality.com/shield/react-perf-tool.png)](http://packagequality.com/#?package=react-perf-tool)

[![Build Status](https://travis-ci.org/RamonGebben/react-perf-tool.svg?branch=master)](https://travis-ci.org/RamonGebben/react-perf-tool) [![Gitter](https://badges.gitter.im/RamonGebben/react-perf-tool.svg)](https://gitter.im/RamonGebben/react-perf-tool?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

[![npm version](https://badge.fury.io/js/react-perf-tool.svg)](https://badge.fury.io/js/react-perf-tool)

[![license](https://img.shields.io/github/license/RamonGebben/react-perf-tool.svg?maxAge=2592000)](https://github.com/RamonGebben/react-perf-tool/blob/master/LICENSE)



ReactPerfTool tries to give you a more visual way of debugging performance of your React application.

It does this by using the addons delivered by the React team and community to get measurements and visualize this using graphs. This makes it easier to spot bottlenecks.



![screenshot](./screenshot.png)



## Usage



```bash

npm i react-perf-tool react-addons-perf -D

```



```javascript

import ReactPerfTool from 'react-perf-tool';

import Perf from 'react-addons-perf';



// Import styles if they don't get loaded already

import 'react-perf-tool/lib/styles.css';



export default function YourApp(props) {

  return (


    {/*...yourApp */}

    

  
);

}

```



## Contributing



If you want to contribute just fork the project and start working on one of the open issues or on your own ideas.

When you are done you can open a pull request.



### Code style

The project uses a trimmed down version of the [Airbnb Javascript styleguide](https://github.com/airbnb/javascript), and can be checked by running:



```bash

npm run lint

```



### Testing

For testing the project uses [Mocha](http://mochajs.org/) and [Chai](http://chaijs.com/).

For testing of components the project uses [Enzyme](https://github.com/airbnb/enzyme).



### TL;DR



* `npm run build` - produces production build

* `npm run dev` - start webpack watch

* `npm run test` - runs the tests and lints

  - `npm run lint` - lints all the code

  - `npm run test:unit` - run only the unit tests

  - `npm run test:component` - run only the component tests