README.md

Write beautiful code for wechat mini app by the beautiful we 👨‍💻‍!

📖 Document

Introduction

---

BeautyWe 是一套专注于微信小程序的企业级开发范式，它的愿景是：

让企业级的微信小程序项目中的代码，更加简单、漂亮。

它由几部分组成：

• 核心 - BeautyWe Core
  对 App、Page 进行抽象和包装，保持传统微信小程序开发姿势，同时开放部分原生能力，让其具有「可插件化」的能力。

• 插件 — BeautyWe Plugins
  得益于 Core 的「可插件化」特性，封装复杂逻辑，形成可插拔式的插件。官方提供了常见需求的解决方案：如增强存储、发布/订阅、状态机、Logger、缓存策略等。

• 框架 - BeautyWe Framework
  描述了一种项目的组织形式，开箱即用，集成了 beautywe core ，并且提供了如：全局窗口、开发规范、多环境开发、全局配置、NPM 等解决方案。

• 自动化 - BeautyWe Cli
  提供快速创建应用、页面、插件，以及项目构建功能的命令行工具。

Usage Example

npm i @beautywe/core @beautywe/plugin-event

import { BtApp } from '@beautywe/core';
import event from '@beautywe/plugin-event';

const myApp = new BtApp({
    // the code as you write for App()
});

myApp.use(event());

App(myApp);

之后，你就能使用 plugin-event 提供的能力了：

const myApp = getApp();

// now you can listening and trigger an event
myApp.event.on('hello', (msg) => console.log(msg));
myApp.event.trigger('hello', 'I am jc');

Contact & Support

• 欢迎通过邮箱来跟我联系: huangjerryc@gmail.com
• 欢迎通过 GitHub issue 提交 BUG、以及其他问题
• 欢迎给该项目点个赞 ⭐️ star on GitHub !

License

This project is licensed under the MIT license.

Copyright (c) JerryC Huang (huangjerryc@gmail.com)