Rax is a progressive framework for building universal applications.
---
π **Write Once, Run Anywhere:** write one codebase, run with `Web`, [`Weex`](https://weex.apache.org/), [`Node.js`](https://nodejs.org/), `Alibaba MiniApp`, and `WeChat MiniProgram`. Rax can be used with additional containers that implement it's [driver specification](https://github.com/alibaba/rax/wiki/Driver-Specification).
β± **Fast:** better performance and a tiny size(π¦~6KB) when compared to [React](http://reactjs.org/) using the same API.
π€ **Easy:** quick start with zero configuration, all features like `Progressive Web App (PWA)`, `Server-Side Rendering (SSR)`, and `Function as a service (FaaS)` can be used out of the box.
### Quick Start π₯’π
#### Start from command line
Create a new Rax project using `create-rax`:
```sh
$ npm init rax
```
_`npm init ` is available in npm 6+_
Start local server to launch project:
```sh
$ cd
$ npm install
$ npm run start
```
#### Start from [VS Code](https://code.visualstudio.com/)
You need to install the [AppWorks Pack](https://marketplace.visualstudio.com/items?itemName=iceworks-team.iceworks) and invoke the `Create Application` command from the VS Code command palette (`Ctrl + Shift + P` or `Cmd + Shift + P` on Mac):
![vscode](https://img.alicdn.com/imgextra/i4/O1CN01B2NdUc1LVH9UffWpV_!!6000000001304-1-tps-960-720.gif)
### Developer Tools π
You can inspect and modify the state of your Rax components at runtime using the
[Rax Developer Tools](https://github.com/raxjs/rax-devtools) browser extension,
however the extension will not work in `production` mode.
1. Install the Chrome [Rax Developer Tools](https://chrome.google.com/webstore/detail/rax-developer-tools/anpeoinhjjligmgoiepbnigjhmijblff) extension
2. Reload and go to the 'Rax' tab in the browser's development tools
#### VS Code Extension
You can use [AppWorks Pack](https://marketplace.visualstudio.com/items?itemName=iceworks-team.iceworks) to get better development experience.
### Awesome Things π
You can find some awesome things in [awesome-rax](https://github.com/raxjs/awesome-rax).
### Contributing π§Ό
Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our [guidelines for contributing](./.github/CONTRIBUTING.md).
#### Code Contributors
This project exists thanks to all the people who contribute.
### Community support
For general help using Rax, please refer to [the official site](https://rax.js.org/). For additional help, you can use one of these channels to ask a question:
- [GitHub](https://github.com/alibaba/rax) (Bug reports, contributions)
- [Twitter](https://twitter.com/RaxNews) (Get the news fast)
- [Medium](https://medium.com/@raxjs) (Get blogs and articles)
- [η₯δΉδΈζ ](https://zhuanlan.zhihu.com/raxjs) (Get blogs and articles in Simplified Chinese)