Moments 使用与配置指南

Moments 使用与配置指南

moments 极简朋友圈 项目地址: https://gitcode.com/gh_mirrors/mom/moments

1. 项目的目录结构及介绍

Moments 是一个开源的极简朋友圈项目，其目录结构如下：

• backend：后端代码目录，使用 Golang 语言编写。
• front：前端代码目录，使用 Vue.js 框架。
• .devcontainer：VSCode 开发容器配置。
• .github：GitHub 工作流和模板文件。
• .gitignore：Git 忽略文件列表。
• Dockerfile：Docker 容器构建文件。
• LICENSE.txt：项目许可证文件。
• Makefile：项目构建文件。
• README.md：项目说明文件。
• docker-compose.yml：Docker Compose 配置文件。
• docker-start.sh：Docker 启动脚本。
• docker-update.sh：Docker 更新脚本。
• app：应用程序数据目录。

2. 项目的启动文件介绍

项目提供了多种启动方式，以下是常见启动文件及其用途：

• docker-start.sh：用于启动 Docker 容器的脚本。
• docker-update.sh：用于更新 Docker 容器的脚本。
• Makefile：通过 make 命令，可以启动后端或前端开发环境。

后端启动：

make backend-dev

前端启动：

make frontend-install # 安装依赖
make frontend-dev     # 启动开发环境

3. 项目的配置文件介绍

项目的配置主要通过环境变量进行，以下是一些主要的配置项：

• PORT：监听端口，默认为 3000。
• CORS_ORIGIN：允许的跨域 Origin 列表。
• JWT_KEY：JWT 密钥，用于生成和验证 JWT 令牌。
• DB：SQLite 数据库存放目录，默认为 /app/data/db.sqlite。
• UPLOAD_DIR：上传文件本地目录，默认为 /app/data/upload。
• LOG_LEVEL：日志级别，可选 info 或 debug。
• ENABLE_SWAGGER：是否启用 Swagger 文档，可选 true 或 false。

项目支持 .env 文件加载环境变量，例如：

JWT_KEY=your_secret_key
LOG_LEVEL=info

使用 Docker 时，可以在 docker-compose.yml 文件中设置环境变量，或者在启动容器时通过 -e 参数传递环境变量。

以上是 Moments 项目的目录结构、启动文件和配置文件的简要介绍。使用前请确保已正确配置开发环境，并仔细阅读官方文档以获取更多详细信息。

moments 极简朋友圈 项目地址: https://gitcode.com/gh_mirrors/mom/moments