mahaiyannn / incubator-weex

Apache Weex (Incubating)

Weex

A framework for building mobile cross-platform UI.

platform	status
Android
iOS
Mobile Web

Supports 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 existing examples.
• Create your own examples by install weex-toolkit with Node.js 8.0+.
  • Run weex init command on an empty folder to generate & start a new project.
  • Follow the instructions from in the project's README file.
• Add an example.
• Enjoy it.

Use Weex

• Tutorial
• Documents

Prerequisites for All Platforms

• Install Node.js 8.0+
• Under the project's root directory, in terminal:
  • Run npm install command, to install project dependencies.
  • Run ./start command.

Android

• Prerequisites
  • Install Android Environment
• 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)

Runtime

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

iOS

• Prerequisites

  • Install iOS Environment
  • Install CocoaPods

• 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

• 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.

Mobile Web

See weex-vue-render.

Scripts

See SCRIPTS.md for more information.

IDE Plugin & Syntax Highlight & DevTool

Weex team have developed a DevTool to help you to improve the debugging efficiency.

See more stuff on this wiki page

Weex Community

• StackOverflow: Ask questions about Weex.
• SegmentFault (cn): 中文交流与讨论
• FAQ
• Articles (cn): Weex 相关文章集合
• Telegram Russian Community Group

Contributing

See Weex Contributing Guide for more information.