SnailyCAD v4 开源项目使用教程

1. 项目目录结构及介绍

SnailyCAD v4 是一个为 FiveM 开发的开源 Computer Aided Dispatch (CAD) 系统。以下是项目的目录结构及其简要介绍：

snaily-cadv4/
├── .github/                    # GitHub 工作流程和配置文件
├── .husky/                     # Husky 配置文件，用于 Git 钩子
├── .vscode/                    # Visual Studio Code 配置文件
├── apps/                       # 应用程序目录
├── packages/                   # 包目录
├── scripts/                    # 脚本目录
├── .deepsource.toml            # DeepSource 配置文件
├── .dockerignore               # Docker 忽略文件
├── .editorconfig               # 编辑器配置文件
├── .env.example                # 环境变量示例文件
├── .eslintrc                   # ESLint 配置文件
├── .gitignore                  # Git 忽略文件
├── .npmrc                      # npm 配置文件
├── .prettierrc                 # Prettier 配置文件
├── CODE_OF_CONDUCT.md          # 行为准则文件
├── Dockerfile                  # Docker 构建文件
├── LICENSE                     # 许可证文件
├── README.md                   # 项目说明文件
├── commitlint.config.js        # Commit Lint 配置文件
├── docker-compose.yml          # Docker Compose 配置文件
├── lerna.json                  # Lerna 配置文件
├── package.json                # npm 包配置文件
├── pnpm-lock.yaml              # pnpm 锁文件
├── pnpm-workspace.yaml          # pnpm 工作空间配置文件
├── production.docker-compose.yml # 生产环境 Docker Compose 配置文件
├── tsconfig.base.json          # TypeScript 配置文件
└── turbo.json                  # Turborepo 配置文件

2. 项目的启动文件介绍

项目的启动主要通过 docker-compose.yml 文件来配置。以下是启动文件的基本介绍：

• docker-compose.yml: 此文件定义了项目的服务，包括数据库、应用服务器等。使用 Docker Compose，可以轻松地启动和管理所有服务。

启动项目时，你需要在项目根目录下运行以下命令：

docker-compose up

这将启动所有在 docker-compose.yml 文件中定义的服务。

3. 项目的配置文件介绍

项目的配置主要通过以下文件进行：

• .env.example: 此文件包含了所有需要的环境变量的示例。在部署项目之前，你需要根据实际情况创建一个 .env 文件，并将示例文件中的值复制过去，然后根据需要进行修改。

以下是一些基本的环境变量：

DB_HOST=localhost
DB_USER=root
DB_PASS=root
DB_DATABASE=snailycad
...

确保所有必要的环境变量都已经正确设置，这对于项目的正常运行至关重要。

在配置和启动项目之后，你可以通过浏览器访问项目的 Web 界面，开始使用 SnailyCAD v4。