|
1 |
| -# React Native Performance tooling |
| 1 | +# @react-native-oh-tpl/react-native-performance |
2 | 2 |
|
3 |
| -Toolchain to measure and monitor the performance of your React Native app in development, pipeline and in production. |
| 3 | +本项目基于 [react-native-performance](https://github.com/react-native-oh-library/react-native-performance) |
4 | 4 |
|
5 |
| -## Packages |
| 5 | +## 文档地址 / Documentation URL |
6 | 6 |
|
7 |
| -### [`react-native-performance`](https://github.com/oblador/react-native-performance/blob/master/packages/react-native-performance/README.md) |
| 7 | +[中文 / Chinese](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-cn/react-native-performance.md) |
8 | 8 |
|
9 |
| -An implementation of the [`Performance` API](https://developer.mozilla.org/en-US/docs/Web/API/Performance) for React Native. |
| 9 | +[英文 / English](https://gitee.com/react-native-oh-library/usage-docs/blob/master/zh-en/react-native-performance.md) |
10 | 10 |
|
11 |
| -- Integrates well with `React.Profiler` API |
12 |
| -- Trace arbitrary events in your app such as component render time |
13 |
| -- Capture network traffic |
14 |
| -- Collect native traces such as script execution and time to interactive of root view |
15 |
| -- Collect native metrics in development such as JS bundle size |
| 11 | +## Codegen |
16 | 12 |
|
17 |
| -### [`flipper-plugin-performance`](https://github.com/oblador/react-native-performance/blob/master/packages/flipper-plugin-performance/README.md) |
| 13 | +该库已接入 codegen,具体请查阅文档。 |
18 | 14 |
|
19 |
| -Visualize performance tracing on a timeline and generic metrics in the debug tool Flipper. |
| 15 | +The library has been integrated with codegen. Please refer to the documentation for details. |
20 | 16 |
|
21 |
| -### [`react-native-performance-flipper-reporter`](https://github.com/oblador/react-native-performance/blob/master/packages/react-native-performance-flipper-reporter/README.md) |
| 17 | +## 请悉知 / Acknowledgements |
22 | 18 |
|
23 |
| -Connect the `react-native-performance` library with the `flipper-plugin-performance` visualization tool in development. |
24 |
| - |
25 |
| -### [`isomorphic-performance`](https://github.com/oblador/react-native-performance/blob/master/packages/isomorphic-performance/README.md) |
26 |
| - |
27 |
| -Isomorphic Performance API for Node, Browser & React Native. Useful if your app targets both web and native. |
28 |
| - |
29 |
| -## Demo |
30 |
| - |
31 |
| -See the projects in the [`examples`](https://github.com/oblador/flipper-plugin-react-native-performance/tree/master/examples) folder. |
32 |
| - |
33 |
| -## Development |
34 |
| - |
35 |
| -Make sure to have [`yarn`](https://classic.yarnpkg.com/lang/en/) v1 installed and run `yarn` in the root folder to install dependencies for all packages. |
36 |
| - |
37 |
| -Uninstall the Flipper Performance plugin if previously installed. Then edit your `~/.flipper/config.json` to look something like this: |
38 |
| - |
39 |
| -``` |
40 |
| -{ |
41 |
| - "pluginPaths": ["/path/to/react-native-performance/packages"] |
42 |
| -} |
43 |
| -``` |
44 |
| - |
45 |
| -Continously compile the plugin as you edit with: |
46 |
| - |
47 |
| -```bash |
48 |
| -yarn workspace flipper-plugin-performance run watch |
49 |
| -``` |
50 |
| - |
51 |
| -Run the example app with: |
52 |
| - |
53 |
| -```bash |
54 |
| -cd examples/vanilla |
55 |
| -yarn start # important to run this before the next step! |
56 |
| -yarn ios # or yarn android |
57 |
| -``` |
58 |
| - |
59 |
| -Run the unit tests with: |
60 |
| - |
61 |
| -```bash |
62 |
| -yarn test |
63 |
| -``` |
64 |
| - |
65 |
| -## License |
66 |
| - |
67 |
| -MIT © Joel Arvidsson 2019 – present |
| 19 | +本项目基于 [The MIT License (MIT)](https://github.com/oblador/react-native-performance/blob/master/LICENSE) ,请自由地享受和参与开源。 |
0 commit comments