Hippy Cross Platform Framework

💡 Introduction

Hippy is a cross-platform development framework, that aims to help developers write once, and run on multiple platforms(iOS, Android, Web, and so on). Hippy is quite friendly to Web developers, especially those who are familiar with React or Vue. With Hippy, developers can create the cross-platform app easily.

Hippy is now applied in Tencent major apps such as Mobile QQ, Mobile QQ Browser, Tencent Video App, QQ Music App, and Tencent News, reaching hundreds of millions of ordinary users.

💯 Advantages

Designed for Web developers, officially support Web frameworks like React and Vue.
Same APIs for different platforms.
Excellent performance with JS engine binding communication.
Build-in recyclable component with better performance.
Smoothly and gracefully migrate to Web browser.
Fully supported Flex Layout engine.

🔨 Getting started

Preparing environment

Make sure you have git and npm installed locally.

Run git clone https://github.com/Tencent/Hippy.git and npm install at project root directory.

The Hippy repository applies git-lfs to manage so,gz,otf files, make sure you have installed git-lfs first.

For macOS developers:

Xcode with iOS sdk: build the iOS app.
Android Studio with NDK: build the android app.
Node.JS: run the build scripts.

homebrew is recommended to install the dependencies.

For Windows developers:

Android Studio with NDK: build the android app.
Node.JS: run the build scripts.

Windows can't run the iOS development environment so far.

Build the iOS simulator with js demo

For iOS, we recommend to use iOS simulator when first try. However, you can change the Xcode configuration to install the app to iPhone if you are an iOS expert.

Run npm run init at root directory.

This command is combined with npm install && npx lerna bootstrap && npm run build.

npm install: Install the project build scripts dependencies.

npx lerna bootstrap: Install dependencies of each npm package.（Hippy uses Lerna to manage multi js packages, if lerna command is not found, execute npm install lerna -g first.）

npm run build: Build each front-end sdk package.
Choose a demo to build with npm run buildexample [hippy-react-demo|hippy-vue-demo|hippy-vue-next-demo] at root directory.
Start the Xcode and build the iOS app with open Hippy.xcworkspace at root directory.

If Step 2 throw error, you can cd to examples hippy-react-demo or hippy-vue-demo or hippy-vue-next-demo, and run npm install --legacy-peer-deps to install demo dependencies first.

More details for iOS SDK integration.

Build the Android app with js demo

For Android, we recommend using the real cellphone for better develop experience, because Hippy is using X5 JS engine which can't support x86 simulator, as well as ARM simulator has a low performance.

Before build the android app, please make sure the SDK and NDK is installed, And DO NOT update the build toolchain.

Run npm run init at root directory.

This command is combined with npm install && npx lerna bootstrap && npm run build.

npm install: Install the project build scripts dependencies.

npx lerna bootstrap: Install dependencies of each npm package.（Hippy uses Lerna to manage multi js packages, if lerna command is not found, execute npm install lerna -g first.）

npm run build: Build each front-end sdk package.
Choose a demo to build with npm run buildexample [hippy-react-demo|hippy-vue-demo|hippy-vue-next-demo] at root directory.
Open Android Project at root directory with Android Studio.
Connect Android phone with USB cable and make sure USB debugging mode is enabled(Run adb devices on the computer terminal to check cellphone connection status).
Open the project with Android Studio, run and install the apk.

If Step 2 throw error, you can cd to examples hippy-react-demo or hippy-vue-demo or hippy-vue-next-demo, and run npm install --legacy-peer-deps to install demo dependencies first.

If you encounter the issue of No toolchains found in the NDK toolchains folder for ABI with prefix: mips64el-linux-android, here is the solution.

More details for Android SDK integration.

Debug the js demo

Follow Build the iOS simulator with js demo or Build the Android app with js demo first to build the App.
Run npm run init:example [hippy-react-demo|hippy-vue-demo|hippy-vue-next-demo] at root directory.
Run npm run debugexample [hippy-react-demo|hippy-vue-demo|hippy-vue-next-demo] dev at root directory.

Or you can cd to examples/hippy-react-demo or examples/hippy-vue-demo or examples/hippy-vue-next-demo directory to run npm run hippy:dev instead.

On example debug mode, npm packages such as @hippy/react, @hippy/vue, @hippy/vue-next are linked to packages > [different package] > dist(not node_modules), so if you have changed js package source code and want to make it take effect in target example, please call npm run build at root directory again.

More details for debugging can be read in Hippy Debug Document.

Build the js production demo

Follow Build the iOS simulator with js demo or Build the Android app with js demo first to build the App.
cd to examples hippy-react-demo or hippy-vue-demo or hippy-vue-next-demo.
Run npm install to install demo js dependencies.
Run npm run hippy:vendor and npm run hippy:build in sequence to build the production vendor.[android|ios].js and index.[android|ios].js.

Hippy demo uses DllPlugin to split the common chunk and app chunk.

How to Integrate

📁 Documentation

To check out hippy examples and visit hippyjs.org.

📅 Changelog

Detailed changes for each release version are documented in the project release notes.

🧱 Project structure

Hippy
├── examples                          # Demo code for frontend or native developer.
│   ├── hippy-react-demo              # hippy-react js demo code.
│   ├── hippy-vue-demo                # hippy-vue js demo code.
│   ├── hippy-vue-next-demo           # hippy-vue-next js demo code.
│   ├── ios-demo                      # iOS native demo code.
│   └── android-demo                  # Android native demo code.
├── packages                          # npm packages.
│   ├── hippy-react                   # React binding for Hippy.
│   ├── hippy-react-web               # Web adapter for hippy-react.
│   ├── hippy-vue-next-style-parser   # style parser for Hippy vue-next.
│   ├── hippy-vue                     # Vue binding for Hippy.
│   ├── hippy-vue-next                # Vue-next binding for Hippy.
│   ├── hippy-vue-css-loader          # Webpack loader for convert CSS text to JS AST.
│   ├── hippy-vue-loader              # Forked from vue-loader to do some hippy customization.
│   ├── hippy-vue-native-components   # Native components extensions for hippy-vue.
│   └── hippy-vue-router              # Vue router for hippy-vue.
├── ios
│   └── sdk                           # iOS SDK
├── android
│   └── sdk                           # Android SDK.
├── core                              # JS modules implemented by C++, binding to JS engine.
├── docker                            # Native release docker image and build scripts.
├── layout                            # Hippy layout engine.
├── static                            # Global static resources stored directory.
└── scripts                           # Project build script.

🤝 Contribution

Developers are welcome to contribute to Tencent's open source, and we will also give them incentives to acknowledge and thank them. Here we provide an official description of Tencent's open source contribution. Specific contribution rules for each project are formulated by the project team. Developers can choose the appropriate project and participate according to the corresponding rules. The Tencent Project Management Committee will report regularly to qualified contributors and awards will be issued by the official contact. Before making a pull request or issue to Hippy, please make sure to read Contributing Guide.

All the people who already contributed to Hippy can be seen in Contributors and Authors File.