Add documentation
Summary: Document Flipper integration with JavaScript clients. Reviewed By: passy Differential Revision: D31827187 fbshipit-source-id: c40d8820241c0f85bd2366a0c087d4270d316c71
This commit is contained in:
Andrey Goncharov
committed by
Facebook GitHub Bot
Facebook GitHub Bot
parent
02115722b3
commit
9b16d0c29a
83
README.md
83
README.md
@@ -14,7 +14,7 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
Flipper (formerly Sonar) is a platform for debugging mobile apps on iOS and Android. Visualize, inspect, and control your apps from a simple desktop interface. Use Flipper as is or extend it using the plugin API.
|
||||
Flipper (formerly Sonar) is a platform for debugging mobile apps on iOS and Android and, recently, even JS apps in your browser or in Node.js. Visualize, inspect, and control your apps from a simple desktop interface. Use Flipper as is or extend it using the plugin API.
|
||||
</p>
|
||||
|
||||
|
||||
@@ -39,44 +39,59 @@
|
||||
|
||||
## Mobile development
|
||||
|
||||
Flipper aims to be your number one companion for mobile app development on iOS and Android. Therefore, we provide a bunch of useful tools, including a log viewer, interactive layout inspector, and network inspector.
|
||||
Flipper aims to be your number one companion for mobile app development on iOS
|
||||
and Android. Therefore, we provide a bunch of useful tools, including a log
|
||||
viewer, interactive layout inspector, and network inspector.
|
||||
|
||||
## Extending Flipper
|
||||
|
||||
Flipper is built as a platform. In addition to using the tools already included, you can create your own plugins to visualize and debug data from your mobile apps. Flipper takes care of sending data back and forth, calling functions, and listening for events on the mobile app.
|
||||
Flipper is built as a platform. In addition to using the tools already included,
|
||||
you can create your own plugins to visualize and debug data from your mobile
|
||||
apps. Flipper takes care of sending data back and forth, calling functions, and
|
||||
listening for events on the mobile app.
|
||||
|
||||
## Contributing to Flipper
|
||||
|
||||
Both Flipper's desktop app and native mobile SDKs are open-source and MIT licensed. This enables you to see and understand how we are building plugins, and of course, join the community and help to improve Flipper. We are excited to see what you will build on this platform.
|
||||
Both Flipper's desktop app, native mobile SDKs, JS SDKs are open-source and MIT
|
||||
licensed. This enables you to see and understand how we are building plugins,
|
||||
and of course, join the community and help to improve Flipper. We are excited to
|
||||
see what you will build on this platform.
|
||||
|
||||
# In this repo
|
||||
|
||||
This repository includes all parts of Flipper. This includes:
|
||||
|
||||
* Flipper's desktop app built using [Electron](https://electronjs.org) (`/desktop`)
|
||||
* native Flipper SDKs for iOS (`/iOS`)
|
||||
* native Flipper SDKs for Android (`/android`)
|
||||
* Plugins:
|
||||
* Logs (`/desktop/plugins/public/logs`)
|
||||
* Layout inspector (`/desktop/plugins/public/layout`)
|
||||
* Network inspector (`/desktop/plugins/public/network`)
|
||||
* Shared Preferences/NSUserDefaults inspector (`/desktop/plugins/public/shared_preferences`)
|
||||
* website and documentation (`/website` / `/docs`)
|
||||
- Flipper's desktop app built using [Electron](https://electronjs.org)
|
||||
(`/desktop`)
|
||||
- native Flipper SDKs for iOS (`/iOS`)
|
||||
- native Flipper SDKs for Android (`/android`)
|
||||
- React Native Flipper SDK (`/react-native`)
|
||||
- JS Flipper SDK (`/js`)
|
||||
- Plugins:
|
||||
- Logs (`/desktop/plugins/public/logs`)
|
||||
- Layout inspector (`/desktop/plugins/public/layout`)
|
||||
- Network inspector (`/desktop/plugins/public/network`)
|
||||
- Shared Preferences/NSUserDefaults inspector
|
||||
(`/desktop/plugins/public/shared_preferences`)
|
||||
- website and documentation (`/website` / `/docs`)
|
||||
|
||||
# Getting started
|
||||
|
||||
Please refer to our [Getting Started guide](https://fbflipper.com/docs/getting-started/index) to set up Flipper.
|
||||
Please refer to our
|
||||
[Getting Started guide](https://fbflipper.com/docs/getting-started/index) to set
|
||||
up Flipper.
|
||||
|
||||
## Requirements
|
||||
|
||||
* node >= 8
|
||||
* yarn >= 1.5
|
||||
* iOS developer tools (for developing iOS plugins)
|
||||
* Android SDK and adb
|
||||
- node >= 8
|
||||
- yarn >= 1.5
|
||||
- iOS developer tools (for developing iOS plugins)
|
||||
- Android SDK and adb
|
||||
|
||||
# Building from Source
|
||||
|
||||
## Desktop
|
||||
|
||||
### Running from source
|
||||
|
||||
```bash
|
||||
@@ -86,12 +101,13 @@ yarn
|
||||
yarn start
|
||||
```
|
||||
|
||||
NOTE: If you're on Windows, you need to use Yarn 1.5.1 until [this issue](https://github.com/yarnpkg/yarn/issues/6048) is resolved.
|
||||
NOTE: If you're on Windows, you need to use Yarn 1.5.1 until
|
||||
[this issue](https://github.com/yarnpkg/yarn/issues/6048) is resolved.
|
||||
|
||||
### Building standalone application
|
||||
|
||||
Provide either `--mac`, `--win`, `--linux` or any combination of them
|
||||
to `yarn build` to build a release zip file for the given platform(s). E.g.
|
||||
Provide either `--mac`, `--win`, `--linux` or any combination of them to
|
||||
`yarn build` to build a release zip file for the given platform(s). E.g.
|
||||
|
||||
```bash
|
||||
yarn build --mac --version $buildNumber
|
||||
@@ -109,11 +125,13 @@ open Sample.xcworkspace
|
||||
<Run app from xcode>
|
||||
```
|
||||
|
||||
You can omit `--repo-update` to speed up the installation, but watch out as you may be building against outdated dependencies.
|
||||
You can omit `--repo-update` to speed up the installation, but watch out as you
|
||||
may be building against outdated dependencies.
|
||||
|
||||
## Android SDK + Sample app
|
||||
|
||||
Start up an android emulator and run the following in the project root:
|
||||
|
||||
```bash
|
||||
./gradlew :sample:installDebug
|
||||
```
|
||||
@@ -130,16 +148,27 @@ Note that the first 2 steps need to be done only once.
|
||||
|
||||
Alternatively, the app can be started on `iOS` by running `yarn ios`.
|
||||
|
||||
## JS SDK + Sample React app
|
||||
|
||||
```bash
|
||||
cd js/react-flipper-example
|
||||
yarn
|
||||
yarn start
|
||||
```
|
||||
|
||||
#### Troubleshooting
|
||||
|
||||
Older yarn versions might show an error / hang with the message 'Waiting for the other yarn instance to finish'. If that happens, run the command `yarn` first separately in the directory `react-native/react-native-flipper`.
|
||||
Older yarn versions might show an error / hang with the message 'Waiting for the
|
||||
other yarn instance to finish'. If that happens, run the command `yarn` first
|
||||
separately in the directory `react-native/react-native-flipper`.
|
||||
|
||||
# Documentation
|
||||
|
||||
Find the full documentation for this project at [fbflipper.com](https://fbflipper.com/).
|
||||
Find the full documentation for this project at
|
||||
[fbflipper.com](https://fbflipper.com/).
|
||||
|
||||
Our documentation is built with [Docusaurus](https://docusaurus.io/). You can build
|
||||
it locally by running this:
|
||||
Our documentation is built with [Docusaurus](https://docusaurus.io/). You can
|
||||
build it locally by running this:
|
||||
|
||||
```bash
|
||||
cd website
|
||||
@@ -148,7 +177,9 @@ yarn start
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
See the [CONTRIBUTING](/CONTRIBUTING.md) file for how to help out.
|
||||
|
||||
## License
|
||||
|
||||
Flipper is MIT licensed, as found in the [LICENSE](/LICENSE) file.
|
||||
|
||||
Reference in New Issue
Block a user