清廉街

这是「清廉街」的前端仓库。

部署

可运行的版本已经上传到 Docker Hub 了，使用下面的命令运行一个实例。

# -p 映射端口 3000 （改冒号前面的）
# --name 容器的名字
# -d 后台运行
docker run -p 3000:3000 -d --name qinglianjie lifeni/qinglianjie:latest

运行后请使用 Caddy 等反向代理域名到 3000 端口或者使用 localhost:3000 查看网页，网页页脚有修改相关 API 地址的按钮，请在配置好后端程序后，填入相关的地址。

开发

前提

开发环境需要 Git、Node.js 16+、Yarn 包管理器。

如果需要进行部署，则还需要使用最新版 Docker 制作镜像。

运行

1. 首先克隆项目。

   git clone https://github.com/QingLianJie/Frontend.git
   cd Frontend
   

2. 其次安装依赖。

   # 没有 yarn 的话，先安装：
   # npm i yarn -g
   yarn
   

3. 如果你要使用出自己的后端的话，在 data/api-config.ts 文件里修改 API 和头像的地址。（不过目前网页页脚也有修改相关 API 地址的按钮，所以也可以不用这种方法，运行之后在网页里改就行，地址会保存到浏览器里。）

   注意： 这个仓库只是前端的项目，网站的大部分功能需要接入后端 API 才能运行。线上 API 地址 有跨域限制，在本地开发无法进行连接，因此在运行前端项目的同时，请确保当前机器上运行有后端程序。

4. 最后运行网站，默认地址为 localhost:3000 。

   # 运行开发环境
   yarn dev
   
   # 运行生产环境
   yarn build
   yarn start
   

环境变量

在本地开发时，可以添加一个 .env.local 文件，即可修改相关的 API 地址。

目前网页页脚也有修改相关 API 地址的按钮，所以也可以不用这种方法。

协议相关

MIT License © 2022 清廉街