incubator-weex README

The project's README from github.com/apache/incubator-weex. As one markdown file: README.md.

Weex

A framework for building Mobile cross-platform UI.

Build Status

Join Us

Join us through mailing list.

Convenience Distribution

Since 0.28.0, Weex would publish two convince binary in each release for Android, please read the documentation about the detail.

Please take the above link seriously, otherwise you would be able to use the latest version of Weex.

platform status
Android sdk Download Or sdk_legacy Download
iOS Pod version Carthage compatible
Mobile Web npm version

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

FYI: The mobile web render is not supported by Apache Weex officially

For Windows

First of all, compiling or building Weex from Windows is not supported officially.

You could install Git for Windows and run all the following commands in git-bash.

Good Luck.

Meet Weex

Use Weex

Android

You should install android environment before building.

You can either build Weex from IDE (Android Studio) or command line.

Build From Android Studio

  1. Open android directory in Android Studio.
  2. Run git submodule update --init --remote in android directory if this is the first time you try to run Weex.

Build From Command Line

Please read How To Build for detail.

iOS

You should install iOS environment before building.

You can either build Weex from IDE (XCode) or command line.

Build From XCode

Build From Command Line

Please read How To Build for detail.

Mobile Web

Vue Render for Apache Weex is a third party plugin, and not developed nor maintained by Apache Weex.

see Vue Render for Apache Weex.

Third part plugin

There is a third party plugin provides for debugging purpose.

You can also view this page for all third party plugin.

Weex Community

Contributing

See Weex Contributing Guide for more information.

incubator-weex (apache/incubator-weex)

apache
Searching Database…

13.6K ·GitHub
archived
What is this?Weex is a framework for building native Mobile cross-platform UI: you write a component once and it renders natively on Android, iOS, and (via a third-party plugin) mobile web.
Is this a UI framework or a standalone app?It is a native UI framework/SDK that you integrate into your own Android app (via Android Studio/Gradle) or iOS app (via Xcode, CocoaPods or Carthage) — not an app you just install.
How do I try Weex before integrating it into a project?Install the Weex Playground app to browse working examples, or install weex-cli on Node.js 8.0+ and run `weex init` to scaffold a simple demo project.
What do I need to actually build it for Android or iOS?For Android you need Android Studio (or the command line) plus `git submodule update --init --remote` on first run; for iOS you need Xcode and either CocoaPods or Carthage to pull in WeexSDK.
Is this project still maintained, and does the web renderer work out of the box?No — the repo is archived (Apache incubator status ended), building from Windows isn't officially supported, and the mobile-web renderer isn't supported by Apache Weex itself, relying instead on an unmaintained third-party Vue Render plugin.
Which OS versions does it actually support?Android 4.1 (API 16) and above, iOS 9.0+, and WebKit 534.30+ for the unofficial web renderer.
What is the Weex Playground?It is an app you install to browse and run already-written Weex example components before building your own, which is the recommended first step for newcomers.
Can I write Weex components using Vue syntax?Yes, Weex ships weex-vue-framework so you can author UI with familiar Vue-like syntax that then compiles down to native rendering on Android and iOS.
Does Weex support building on Windows?Not officially — the README says compiling Weex on Windows isn't officially supported, though you can try installing Git for Windows and running the build commands in git-bash.
Where do I ask questions about Weex?The project points users to its mailing list, StackOverflow, a Chinese SegmentFault community, and a Russian Telegram group for discussion.
Which topics is it in?apache, cocoapods, xcode, vue, deprecated, sdk, c++, mobile, ui, ios, android, framework
Creator
apache
Size
276.1 MB
Stars
13.6K
Age
9y
Commits · 90 Days