flipper

(β˜… 13,456)

A desktop debugging platform for mobile developers.

  • .eslintignore
  • .flowconfig
  • .gitattributes
  • .gitignore
  • .ignore
  • .sonarhandles
  • _watchmanconfig
  • build.gradle
  • CHANGELOG.md
  • CNAME
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • DEV_ENVIRONMENT.md
  • Flipper.podspec
  • FlipperKit.podspec
  • gradle.properties
  • gradlew
  • gradlew.bat
  • LICENSE
  • README.md
  • settings.gradle

# Installation Guide

1. Get the code
git clone https://github.com/facebook/flipper

Downloads the entire project code from GitHub to your computer.

cd flipper

Moves into the project folder you just downloaded.

2. CMake

Medium Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • CMake The tool used to generate build configuration.
  • C/C++ 컴파일러 Windows needs Visual Studio (Community edition, free), macOS needs Xcode Command Line Tools, Linux needs the gcc/g++ package.
cd android

This project's files live in a subfolder, so move into it first.

mkdir build && cd build

Creates a folder to hold the build output and moves into it.

cmake ..

Analyzes the source code and generates build configuration files (must be run inside the build folder).

make

Compiles the code based on the generated build configuration to produce an executable.

βœ… Check that an executable was created inside the build folder, then run it directly (e.g. ./build/app_name).

3. .NET

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • .NET SDK The SDK required for the dotnet command.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd react-native/ReactNativeFlipperExample/windows

This project's files live in a subfolder, so move into it first.

dotnet restore

Downloads the packages the project depends on.

dotnet run

Builds the project and runs it immediately.

βœ… After dotnet run, check the message or address shown in the terminal.

4. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
./gradlew :sample:installDebug

Builds the project using Gradle.

βœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

5. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
yarn

Downloads and installs the libraries listed in package.json.

yarn start

Starts the development/run server.

yarn build --mac

Builds optimized production files.

yarn android

Type this command into your terminal and run it.

yarn install

Downloads and installs the libraries listed in package.json.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

6. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cd packer

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation