https://github.com/jd-opensource/fepubfree
前端发布平台
https://github.com/jd-opensource/fepubfree
Last synced: about 1 year ago
JSON representation
前端发布平台
- Host: GitHub
- URL: https://github.com/jd-opensource/fepubfree
- Owner: jd-opensource
- License: mit
- Created: 2022-10-27T03:36:15.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-10-27T09:42:52.000Z (over 3 years ago)
- Last Synced: 2025-03-27T08:58:18.039Z (about 1 year ago)
- Language: TypeScript
- Size: 165 KB
- Stars: 149
- Watchers: 4
- Forks: 29
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pubfree 前端发布平台
## 描述
### 主要技术栈
- 前端 React + Antd
- 后端 NodeJS + MySQL
- 工具 pnpm、vite
## 目录
- [Pubfree 前端发布平台](#pubfree-前端发布平台)
- [描述](#描述)
- [主要技术栈](#主要技术栈)
- [目录](#目录)
- [安装](#安装)
- [安装 pnpm](#安装-pnpm)
- [安装依赖](#安装依赖)
- [数据库建表](#数据库建表)
- [运行 server-api](#运行-server-api)
- [运行 server-client](#运行-server-client)
- [运行 client-web](#运行-client-web)
- [使用](#使用)
- [快速发布流程](#快速发布流程)
- [1. 创建项目](#1-创建项目)
- [2. 资源发布](#2-资源发布)
- [3. 资源生效](#3-资源生效)
- [4. 查看页面](#4-查看页面)
- [License](#license)
## 安装
安装前请确保已安装 MySQL 和 NodeJS，为了正常使用 vite, 请确保 NodeJS 版本为 ^14.18.0 || >=16.0.0。
### 安装 pnpm
````bash
npm install -g pnpm
````
查看 pnpm 版本，确认 pnpm 已经安装成功
````bash
pnpm -v
````
### 安装依赖
项目根目录下安装项目依赖
````bash
pnpm install
````
### 数据库建表
将 open-source/packages/server-api/script/sql/init.sql 文件中的 sql 语句复制到 MySQL 中运行，建立服务所需的基本数据库表。
### 运行 server-api
在 open-source/packages/server-api/resource 下新建 config.default.json，并配置数据库等信息
````js
{
"orm": {
"host": "127.0.0.1",
"port": 3306,
"database": "pubfree_open",
"username": "root",
"password": "root"
}
}
````
本地运行
````bash
cd packages/server-api
pnpm dev
````
在本地 http://127.0.0.1:7001 下便可访问到 cms 页面用到的接口。
### 运行 server-client
在 open-source/packages/server-client/resource 下新建 config.default.json，并配置数据库等信息
````js
{
"mysql": {
"enable": true,
"options": {
"host": "127.0.0.1",
"port": 3306,
"database": "pubfree_open",
"username": "root",
"password": "root"
}
},
"schedule": {
"enable": true
}
}
````
本地运行
````bash
cd packages/server-client
pnpm dev
````
通过 http://127.0.0.1:3000 可访问到发布在平台上的页面。
### 运行 client-web
本地运行
````bash
cd packages/client-web
pnpm dev
````
通过 http://localhost:5173 可访问发布平台的 cms 页面。
## 使用
### 快速发布流程
#### 1. 创建项目
#### 2. 资源发布
使用 zip 上传（本地开发环境不支持）或者输入 html 资源地址发布
#### 3. 资源生效
#### 4. 查看页面
## License
[MIT © JD.com, Inc.](./LICENSE)