From 4be95f3dc997e812411dd08fc2e7c0d578877b12 Mon Sep 17 00:00:00 2001 From: Max Date: Mon, 21 Nov 2022 13:25:29 +0800 Subject: [PATCH] [change] readme --- README.md | 77 +++++++++++++++++---------------------------- README.zh-CN.md | 83 ++++++++++++++++++++++--------------------------- 2 files changed, 67 insertions(+), 93 deletions(-) diff --git a/README.md b/README.md index 45185831..86607853 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,7 @@

-![intro](docs/architecture.png) +![intro](https://release-bj.yaoapps.com/docs/v0.10.2/介绍/assets/architecture.png) [中文介绍](README.zh-CN.md) @@ -57,19 +57,13 @@ YAO adopts a flow-based programming model to implement various functions by writ Applications developed with YAO -| Application | INTRO | REPO | -| ----------- | ----------------------------------- | ------------------------------------- | -| YAO WMS | Warehouse Management Sytem | https://github.com/yaoapp/yao-wms | -| LMS DEMO | Library Management System Demo | https://github.com/yaoapp/demo-lms | -| CRM DEMO | Customer Management System Demo | https://github.com/YaoApp/demo-crm | -| AMS DEMO | Asset Management Sytem Demo | https://github.com/YaoApp/demo-asset | -| Widget DEMO | Self-Hosting Low Code Platform Demo | https://github.com/YaoApp/demo-widget | - -### Intelligent warehouse management system - -An example of cloud + edge IoT application, an unattended intelligent warehouse management system that supports face recognition and RFID. - -[https://demo-wms.yaoapps.com](https://demo-wms.yaoapps.com/xiang/login/admin?autoLogin=true) +| Application | INTRO | REPO | +| ------------------- | ----------------------------------- | -------------------------------------- | +| yaoapp/yao-admin | Admin Dashboard | https://github.com/yaoapp/yao-admin | +| yaoapp/demo-app | Demo App | https://github.com/yaoapp/demo-app | +| yaoapp/demo-project | Project management system (Demo) | https://github.com/yaoapp/demo-project | +| yaoapp/demo-finance | Finance management system (Demo) | https://github.com/yaoapp/demo-finance | +| yaoapp/demo-plm | Production management system (Demo) | https://github.com/yaoapp/demo-plm | ## Introduce @@ -91,51 +85,38 @@ For Windows users, please refer to the Installation and Debugging chapter: [Inst ## Getting Started -### Step 1: Create a project +### Create a blank project -Create a new project directory, enter the project directory, and run the `yao init` command to create a blank Yao application. +Create a new application directory, enter the application directory, run the `yao start` command, and start the installation. ```bash -mkdir -p /data/crm # create project directory -cd /data/crm # Enter the project directory -yao init # run the initializer +mkdir -p /data/app # create project directory +cd /data/app # Enter the project directory +yao start # Start installation ``` -After the command runs successfully, the `app.json file` , `db`, `ui` , `data` and other directories will be created +**Default Account** + +- User: **xiang@iqka.com** + +- Password: **A123456p+** + +### Download a project + +Create a new project directory, enter the project directory, run the `yao get` command, and download the application code. ```bash -├── data # Used to store files generated by the application, such as pictures, PDFs, etc. -├── db # Used to store SQLite database files -│ └── yao.db -└── ui # The static file server file directory, where custom front-end products can be placed. The files in this directory can be accessed through http://host:port/filename . -└── app.json # Application configuration file, used to define the application name, etc. +mkdir -p /data/app # create project directory +cd /data/app # Enter the project directory +yao get yaoapp/demo-app # download demo-app +yao start # Start installation ``` -### Step 2: Create the data table +**Default Account** -Use the `yao migrate` command to create the data table, open the command line terminal, **run in the project root directory**: +- User: **xiang@iqka.com** -```bash -yao migrate -``` - -initialization menu - -```bash -yao run flows.setmenu -``` - -### Step 3: Start the service - -Open a command line terminal, **run in the project root directory**: - -```bash -yao start -``` - -1. Open a browser, visit `http://127.0.0.1:5099/xiang/login/admin`, - -2. Enter the default username: `xiang@iqka.com`, password: `A123456p+` +- Password: **A123456p+** ## About Yao diff --git a/README.zh-CN.md b/README.zh-CN.md index 55f1b3c1..901073d9 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -3,7 +3,7 @@ [![UnitTest](https://github.com/YaoApp/yao/actions/workflows/unit-test.yml/badge.svg)](https://github.com/YaoApp/yao/actions/workflows/unit-test.yml) [![codecov](https://codecov.io/gh/YaoApp/yao/branch/main/graph/badge.svg?token=294Y05U71J)](https://codecov.io/gh/YaoApp/yao) -![intro](docs/architecture.png) +![介绍](https://release-bj.yaoapps.com/docs/v0.10.2/%E4%BB%8B%E7%BB%8D/assets/architecture.png) [English](README.md) @@ -23,19 +23,21 @@ YAO 采用 flow-based 的编程模式，通过编写 YAO DSL (JSON 格式逻辑 微信群: 添加微信 17192175099 备注(开发交流) -![微信群](docs/wechat.jpg) +![微信群](https://release-bj.yaoapps.com/docs/v0.10.2/%E4%BB%8B%E7%BB%8D/assets/wechat.jpg) ## 演示 使用 YAO 开发的典型应用 -| 应用 | 介绍 | 代码仓库 | -| ----------- | -------------------- | ------------------------------------- | -| YAO WMS | 仓库管理系统 | https://github.com/yaoapp/yao-wms | -| LMS DEMO | 图书管理系统(演示) | https://github.com/yaoapp/demo-lms | -| CRM DEMO | 客户管理系统(演示) | https://github.com/YaoApp/demo-crm | -| AMS DEMO | 资产管理系统(演示) | https://github.com/YaoApp/demo-asset | -| Widget DEMO | 自建低代码平台(演示) | https://github.com/YaoApp/demo-widget | +![界面](https://release-bj.yaoapps.com/docs/v0.10.2/%E5%9F%BA%E7%A1%80/assets/yao-setup-demo.jpg) + +| 应用 | 简介 | 代码仓库 | +| ------------------- | -------------------------- | -------------------------------------- | +| yaoapp/yao-admin | 一个通用管理后台 | https://github.com/yaoapp/yao-admin | +| yaoapp/demo-app | 演示应用 (演示) | https://github.com/yaoapp/demo-app | +| yaoapp/demo-project | 工程项目管理演示应用(演示) | https://github.com/yaoapp/demo-project | +| yaoapp/demo-finance | 财务管理演示应用(演示) | https://github.com/yaoapp/demo-finance | +| yaoapp/demo-plm | 生产项目管理演示应用(演示) | https://github.com/yaoapp/demo-plm | ## 介绍 @@ -45,7 +47,7 @@ Yao 基于 **flow-based** 编程思想，采用 **Go** 语言开发，支持多 Yao 内置了一套数据管理系统，通过编写 **JSON** 描述界面布局，即可实现 90% 常见界面交互功能，特别适合快速制作各类管理后台、CRM、ERP 等企业内部系统。对于特殊交互功能亦可通过编写扩展组件或 HTML 页面的方式实现。内置管理系统与 Yao 并不耦合，亦可采用 **VUE**, **React** 等任意前端技术实现管理界面。 -## Install +## 安装 在终端下运行脚本: ( MacOS / Linux ) @@ -53,55 +55,46 @@ Yao 内置了一套数据管理系统，通过编写 **JSON** 描述界面布局 curl -fsSL https://website.yaoapps.com/install.sh | bash ``` -Windows 用户请参考安装调试章节: [安装调试](https://yaoapps.com/doc/a.介绍/b.安装调试) +Windows 用户请参考安装调试章节: [安装调试](https://yaoapps.com/doc/%E4%BB%8B%E7%BB%8D/%E5%AE%89%E8%A3%85%E8%B0%83%E8%AF%95) ## 入门指南 -### Step 1: 创建项目 +### 创建应用 -新建一个项目目录，进入项目目录，运行 `yao init` 命令，创建一个空白的 Yao 应用。 +#### 新建一个空白应用 + +新建一个应用目录，进入应用目录，运行 `yao start` 命令, 启动安装界面。 ```bash -mkdir -p /data/crm # 创建项目目录 -cd /data/crm # 进入项目目录 -yao init # 运行初始化程序 +mkdir -p /data/app # 创建应用目录 +cd /data/app # 进入应用目录 +yao start # 启动安装界面 ``` -命令运行成功后，将创建 `app.json文件` , `db`, `ui` , `data` 等目录 +**默认账号** + +- 用户名: **xiang@iqka.com** + +- 密码: **A123456p+** + +[安装界面](https://release-bj.yaoapps.com/docs/v0.10.2/%E5%9F%BA%E7%A1%80/assets/yao-setup-step2.jpg) + +#### 下载已上架应用 + +新建一个项目目录，进入项目目录，运行 `yao get` 命令, 下载应用代码。 ```bash -├── data # 用于存放应用产生的文件，如图片,PDF等 -├── db # 用于存放 SQLite 数据库文件 -│ └── yao.db -└── ui # 静态文件服务器文件目录，可以放置自定义前端制品，该目录下文件可通过 http://host:port/文件名称 访问。 -└── app.json # 应用配置文件, 用来定义应用名称等 +mkdir -p /data/app # 创建应用目录 +cd /data/app # 进入应用目录 +yao get yaoapp/demo-app # 下载应用代码 (必须为空目录) +yao start # 启动安装界面 ``` -### Step 2: Create the data table +**默认账号** -使用 `yao migrate` 命令创建数据表，打开命令行终端，**在项目根录下运行**: +- 用户名: **xiang@iqka.com** -```bash -yao migrate -``` - -初始化菜单 - -```bash -yao run flows.setmenu -``` - -### Step 3: Start the service - -打开命令行终端，**在项目根录下运行**: - -```bash -yao start -``` - -1. 打开浏览器, 访问 `http://127.0.0.1:5099/xiang/login/admin`， - -2. 输入默认用户名: `xiang@iqka.com`， 密码: `A123456p+` +- 密码: **A123456p+** ## 关于 Yao