README.md

Weex

Android iOS HTML5

A framework for building Mobile cross-platform UI.

_{(English Gitter) (Chinese 中文聊天室)}

Support Android 4.1 (API 16) and iOS 7.0+. See Weex website for more information.

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

• Tutorial
• Doc: English, 中文

Android

0. Prerequisites 0. Install Node.js 4.0+ 0. Under project root 0. npm install, install project 0. ./start 0. Install Android Environment
1. Run playground, In Android Studio 0. Open android/playground 0. In app/java/com.alibaba.weex/IndexActivity, modify CURRENT_IP to your local IP 0. Click (Run button)
2. Add an example

Runtime

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

iOS

0. Prerequisites 0. Install Node.js 4.0+ 0. Under project root 0. npm install, install project 0. ./start 0. Install iOS Environment 0. Install CocoaPods
1. Run playground 0. cd ios/playground 0. pod install 0. Open WeexDemo.xcworkspace in Xcode 0. Click (Run button) or use default shortcut cmd + r in Xcode 0. If you want to run the demo on your device. In DemoDefine.h(you can search this file by Xcode default shortcut cmd + shift + o), modify CURRENT_IP to your local IP
2. Add an example

Scripts

See SCRIPTS.md for more information.

IDE Plugin & Syntax Highlight & DevTool

See Weex Community Wiki page

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

FAQ

See FAQ for more information.

Community based Weex knowledge site

• weex article : article collection about Weex(文章集合)
• weex.help : 3rd forum about Weex(第三方Weex中文技术论坛)
• gitter.im chinese room : an instant message chat room about Weex(Weex中文聊天室)

Contributing

See Weex Contributing Guide for more information.