Go to file
AppsmithCN bc39623ead
update README.md.
Signed-off-by: AppsmithCN <10857575+appsmithcn@user.noreply.gitee.com>
2023-08-04 10:39:27 +00:00
.github Release frozen (#6423) 2021-08-06 15:24:23 +05:30
app [!] add demo json, bug fix 2022-07-07 11:46:02 +08:00
ci Add caching in CodeBuild CI for Docker images 2021-07-22 18:11:00 +05:30
contributions Adds YT Setup Videos to Docs (#5744) 2021-07-09 15:54:34 +05:30
demo add IT assets manage demo 2022-10-12 09:58:03 +08:00
deploy Use CentOS repo for RHEL installation (#6069) 2021-07-22 15:27:34 +05:30
static fix: replace banner p 2023-08-04 10:36:49 +00:00
.all-contributorsrc docs: add aswathkk as a contributor for code (#5490) 2021-06-30 12:51:15 +05:30
.deepsource.toml Create .deepsource.toml (#3593) 2021-03-19 11:40:59 +05:30
.env.example [Feature #3379] Added recaptcha for signup (#4701) 2021-06-08 11:10:11 +05:30
.gitignore [Feature] Grid Widget (#2389) 2021-04-23 11:13:13 +05:30
.imgbotconfig Added imgbot config file (#1655) 2020-11-09 17:52:53 +05:30
API.png [ImgBot] Optimize images (#1513) 2020-11-02 19:44:01 +05:30
CODE_OF_CONDUCT.md Readme (#11) 2020-07-01 16:42:41 +05:30
CONTRIBUTING.md Update CONTRIBUTING.md 2021-01-27 18:07:13 +05:30
IssuesReport.md Feature/hacktoberfest (#841) 2020-09-30 23:23:10 +05:30
LICENSE Update LICENSE 2021-05-27 12:53:55 +05:30
Query.png [ImgBot] Optimize images (#1513) 2020-11-02 19:44:01 +05:30
README.md update README.md. 2023-08-04 10:39:27 +00:00
SECURITY.md Creating SECURITY.md for reporting security vulnerabilities 2020-12-12 22:12:49 +05:30
app.json Removing non-required fields from Heroku deployment. (#5978) 2021-07-20 23:30:59 +05:30
appsmith_templates.md Create appsmith_templates.md (#4412) 2021-06-23 19:32:23 +05:30
coverage-summary.json Improve autocomplete sorting (#5798) 2021-07-20 15:32:56 +05:30
heroku.yml Heroku Button implementation (#1721) 2020-11-18 18:53:59 +05:30
install.sh [!] better install script 2022-06-15 21:27:35 +08:00
office_hours.md chore: Updates contact email 2021-07-20 10:10:03 +01:00

README.md

PagePlug

为开发者而生的开源前端低代码【中国版AppSmith】

快速开始帮助中文社区

PagePlug 是基于 AppSmith 打造的更适合中国开发者的开源前端低代码项目。
无需侵入客户架构直接连接数据源API、DB无需学习任何第三方概念使用基础 js 知识就可以快速生成多平台前端应用,包括 PC 端 web 应用、微信小程序等。

当前版本基于 AppSmith v1.5.15 版本,最新版本正在开发中,敬请期待。

功能特色

  • 支持移动端!一分钟制作一个小程序,并生成小程序码进行分享!

  • 丰富的移动端组件

  • 集成社区中功能拔群的表单解决方案 Formily

  • PC端应用支持自定义导航菜单

  • 中文界面、更简洁的 UI

  • 引入 antd 组件库react 版本升级到 v17

  • 简化启动步骤支持Windows环境本地开发无需WSL
    官方 AppSmith 前端项目第一次启动步骤繁琐,依赖非常多,并且官方支持 Windows 平台本地开发是通过 WSL 实现的配置非常麻烦PagePlug 优化了 Windows 环境下的运行脚本,简化了项目启动过程。详请

DEMO 项目

  • 严选小程序(微信小程序)

    PagePlug 制作的完整电商小程序案例,支持注册、登录、二级商品分类、商品搜索、商品详情、购物车、购买下单、收货地址管理、订单管理等功能。后端接口使用开源后台 litmall 的一个部署实例(实例来自 flutter_mall,实名感谢!)

  • 工程管理系统PC web应用
    体验地址
    PagePlug 制作的一个典型CRUD项目实现了基本增删改查、后端分页、搜索过滤、弹窗表单、复杂表单等功能

快速开始

  • 🚀 立即体验(可使用任意邮箱注册登录)

    注意体验环境数据没有做持久化只作功能演示使用如果需要长期使用请使用我们推荐的SaaS版本

  • 🌈 稳定SaaS版本Methodot推荐
    https://methodot.com
    Methodot 是一站式云原生在线开发协作平台,它通过独创的在线应用架构图,深度集成了 PagePlug 的前端低代码功能,还支持通过 WebIDE 进行传统方式的应用开发,实现了 procode + lowcode 的深度结合,一键编译、构建、发布、运维你的应用。

  • 🌱 私有部署【Docker】推荐

    最低服务器配置4G内存 + 2核CPU

    // 获取安装脚本
    curl -O https://raw.githubusercontent.com/cloudtogo/pageplug/open/install.sh
    
    // 赋予运行权限
    chmod +x install.sh
    
    // 执行安装脚本
    ./install.sh
    

🎈 本地开发

PagePlug 代码位于 /app 目录下,主要目录分别是:

  • /client -- React 前端项目,使用 create-react-app 脚手架生成,负责低代码的编辑器和 web 端展示
  • /server -- Java 后端项目,使用 Spring WebFlux 框架,负责低代码的后端服务、各种数据源的代理
  • /taro -- Taro 移动端项目,使用 Taro 跨平台方案实现移动端对低代码 DSL 的解析和展示

PagePlug 前端启动

PagePlug 前端项目使用 Nginx 作为网关,并且 Nginx 使用 Docker 运行,所以在运行之前请确保已安装 Docker ,下面的启动命令仅针对 Windows 环境非Windows环境请参考官方指南

// 配置 host
127.0.0.1 dev.appsmith.com

// 环境变量
cp .env.example .env

// 启动本地 nginx docker
cd app/client
yarn start-proxy

// 启动前端服务
yarn
yarn start-win

顺利启动后,访问 https://dev.appsmith.com 预览效果。

PagePlug 后端启动

PagePlug 后端启动需要 Jdk11、Maven3、一个Mongo实例和一个Redis实例具体操作请参考官方指南。下面的启动命令仅针对 Windows 环境Windows环境运行脚本需要借助 bash 命令,非 Windows 环境下直接运行脚本即可。

注意build.sh 脚本中用到了 rsync 工具,启动前请确保系统中已经安装了 rsyncWindows环境安装 rsync 请看这里

// 使用 IDEA 打开工程
app/server

// 创建环境变量文件
cp envs/dev.env.example .env

// 打开.env配置环境变量
APPSMITH_MONGODB_URI="你的Mongo实例地址"
APPSMITH_REDIS_URL="你的Redis实例地址"

// 构建 java 服务
mvn clean compile
bash ./build.sh -DskipTests

// 启动 java 服务
bash ./scripts/start-dev-server.sh

PagePlug 移动端启动

PagePlug 移动端是一个 Taro 项目天然地支持多端小程序、H5和React Native但是目前 PagePlug 仅支持微信小程序,微信小程序的预览和发布需要使用微信开发者工具、小程序账号,开发前请先查看微信小程序官方指南
PagePlug 移动端组件采用 Taroify UI组件库打造。

cd app/taro

打开 config/dev.js 配置开发参数

// PagePlug 后端接口地址本地开发时需要填写本机IP地址
API_BASE_URL: '"http://192.168.xxx.xxx:8080/api/"'

// 小程序默认展示的应用ID你可以从应用的url中找到应用ID/app/[应用ID]/page/[页面ID]
DEFAULT_APP: '"应用ID"'

// 启动 Taro 项目
yarn
yarn dev:weapp

帮助

贡献者

AppSmith团队王昆

感谢这些巨人

PagePlug 代码中使用到的才华横溢的开源项目,感谢这些开源项目让世界更美好!

LICENSE

本项目基于 Apache License 2.0 开源协议