/incubator-weex

Mirror of Apache Weex

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Weex

A framework for building Mobile cross-platform UI.

AndroidDownload iOSPod version Carthage compatible HTML5npm version

CircleCI

Support Android 4.1 (API 16), iOS 8.0+ and WebKit 534.30+.

For Windows

Please INSTALL Git for Windows and run all the following commands in git-bash.

Meet Weex

  • Install Weex Playground App to see examples we already written.
  • If you want to write a demo, install weex-toolkit in Node.js 4.0+ and
  • Run weex init to generate & start a simple project in an empty folder.
  • Follow the instructions in the project README.
  • Enjoy it.

Use Weex

Android

  • Prerequisites
  • Run playground, In Android Studio
    • Open android/playground
    • In app/java/com.alibaba.weex/IndexActivity, modify CURRENT_IP to your local IP
    • Click (Run button)
  • Add an example

Runtime

On Android Platform , Weex code is executed in weex_v8core which is based on Google V8 JavaScript engine.

iOS

  • run playground

    • Prerequisites
    • Run playground
      • cd ios/playground
      • pod install
      • Open WeexDemo.xcworkspace in Xcode
      • Click (Run button) or use default shortcut cmd + r in Xcode
      • If you want to run the demo on your device, don't need to modify CURRENT_IP manually. In DemoDefine.h(you can search this file by Xcode default shortcut cmd + shift + o), modify CURRENT_IP to your local IP
    • Add an example
  • integrate to your application

    • CocoaPods

      Add the following line to your Podfile:

        pod 'WeexSDK'
      

      run pod install

    • Carthage

      Add the following line to your Cartfile:

        github "apache/incubator-weex"
      

      Run carthage update, and you should now have the latest version of WeexSDK in your Carthage folder.

Scripts

See SCRIPTS.md for more information.

IDE Plugin & Syntax Highlight & DevTool

Weex team have developed a DevTool to help you to improve we file debug efficiency.

See more stuff on this wiki page

Weex Community

Contributing

See Weex Contributing Guide for more information.