You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
paopao-ce/README.md

5.1 KiB

Go Report Card Forks Stargazers MIT License Contributors Issues

Logo

PaoPao

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


预览

Web端
明色主题

暗色主题

更多演示请前往官网体验(谢绝灌水)

桌面端:

(back to top)

🛠 技术栈

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

🏗 快速开始

环境要求

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

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

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

安装说明

宝塔安装

我们为宝塔用户提供了超详细安装教程 点此查看

普通安装

克隆代码库

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

后端

  1. 导入项目根目录下的 paopao.sql 文件至MySQL数据库

  2. 拷贝项目根目录下 config.yaml.sample 文件至 config.yaml,按照注释完成配置编辑

  3. 编译后端
    编译api服务:

    make build
    

    编译api服务、内嵌web前端ui; 注意此步骤需要先编译web前端。

    make build TAGS='embed'
    

    编译后在dist目录可以找到对应可执行文件。

  4. 启动后端
    运行api服务:

    make run
    

    运行api服务、web前端ui服务:

    make run TAGS='embed'
    

前端

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

    cd ./web
    vim .env
    yarn
    
  2. 编译前端

    yarn build
    

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

桌面端

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

    cd ./web
    vim .env
    yarn
    
  2. 编译前端

    yarn build
    
  3. 构建桌面端

    yarn tauri build
    

    桌面端是使用Rust + tauri编写 的需要Rust编译环境具体安装指南请参考https://www.rust-lang.org/tools/install.

其他说明

建议后端服务使用 supervisor 守护进程,并通过 nginx 反向代理后提供API给前端服务调用。

短信通道使用的聚合数据,如果申请不下来,可以考虑替换其他服务商。

代码结构比较简单,很方便扩展

👯‍♀️ 贡献

喜欢的朋友欢迎给个Star、贡献PR。

License

Distributed under the MIT License. See LICENSE for more information.