paopao-ce/README.md

PaoPao

🔥一个清新文艺的微社区
View Demo · Report Bug · Features

1. 截图预览

更多演示请前往官网体验（谢绝灌水）

(back to top)

2. 快速开始

2.1 技术栈

PaoPao主要由以下优秀的开源项目/工具构建

• Go
• Gin
• Zinc
• Naive UI
• Vue.js
• Vite.js

2.2 环境要求

• Go (1.17+)
• Node.js (14+)
• MySQL (5.7+)
• Redis
• Zinc

* Zinc是一款轻量级全文搜索引擎，可以查阅 https://zincsearch.com/ 安装

以上环境版本为PaoPao官方的开发版本，仅供参考，其他版本的环境未进行充分测试

3. 安装说明

克隆代码库

git clone https://github.com/rocboss/paopao-ce.git

3.1 后端

1. 导入项目根目录下的 paopao.sql 文件至MySQL数据库
2. 拷贝项目根目录下 config.yaml.sample 文件至 config.yaml，按照注释完成配置编辑
3. 编译后端

   go mod download
   go build .
   

4. 启动后端

   chmod +x paopao-api
   ./paopao-api
   

3.2 前端

1. 进入前端目录 web，编辑 .env 文件中后端服务地址，下载依赖包

   cd ./web
   vim .env
   yarn
   

2. 编译前端

   yarn build
   

   build完成后，可以在dist目录获取编译产出，配置nginx指向至该目录即可

3.3 其他

建议后端服务使用 supervisor 守护进程，并通过nginx反向代理后，提供API给前端服务调用。 短信通道使用的juhe数据，如果申请不下来，可以考虑替换其他服务商。 代码结构比较简单，喜欢的朋友欢迎给个Star、贡献PR。