快速上手

使用 create-remax-app 选择你要创建的小程序。

受支持的小程序列表:

  • 阿里系小程序(包括支付宝、钉钉、淘宝等)
  • 微信小程序 (包括 QQ 小程序)
  • 头条小程序
  • 跨平台(支持以上所有)

注意

Remax 要求 Node.js 版本大于等于 12

创建项目

$ npx create-remax-app my-app
$ cd my-app && npm install

运行项目

$ npm run dev # 非跨平台
or
$ npm run dev <platform> # 跨平台,如:要在阿里小程序环境运行,则 npm run dev ali

打开小程序开发者工具,选中项目下的 dist 目录,你将看到

成功!

项目结构

现在我们来看一下 Remax 应用的结构:

my-app/
┳ package.json
┣ dist/
┣ node_modules/
┣ public/
┣ src/
┗━┓ app.js
┣ app.css
┣ app.config.js
┣ pages/
┗━┓ index/
┗━┓
┣ index.js
┣ index.css
┣ index.config.js

dist 为编译后的文件目录。

public 为全局静态资源目录,具体可参考public 目录

src 为源文件目录。

app.js 入口文件,具体可参考 指南 - 框架

app.css 全局样式文件。

app.config.js 为小程序全局配置文件,对应 app.json,具体可参考 指南 - 配置

module.exports = {
pages: ['pages/index/index'],
window: {
defaultTitle: 'My Project',
},
};

pages 存放项目页面。

import * as React from 'react';
import { View, Text } from 'remax/ali';
import './index.css';
export default () => {
return (
<View>
<Text>pages/index/index</Text>
</View>
);
};

默认导出的的 React 组件就是当前的页面,关于生命周期的使用方式参考《生命周期》。

Remax 针对不同平台提供了对应的组件和 API,如 remax/aliremax/wechatremax/toutiao 等等,你可以根据需要选择对应的平台。关于跨平台开发请参考《跨平台开发》。

index.css 页面样式文件,关于样式请参考《样式》。

index.config.js 页面配置文件,会自动转换成小程序页面配置文件 index.json,关于配置请参考《配置》。