GitSave 使用与配置指南

1. 项目目录结构及介绍

GitSave 项目的主要目录结构如下所示：

GitSave/
├── .github/
│   └── workflows/
├── backend/
├── prisma/
├── public/
├── src/
├── .dockerignore
├── .gitignore
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── README.md
├── astro.config.mjs
├── package-lock.json
├── package.json
└── tailwind.config.mjs

• .github/workflows/: 存放 GitHub Actions 工作流的配置文件，用于自动化一些任务，如发布 Docker 镜像等。
• backend/: 包含项目后端代码。
• prisma/: 包含 Prisma 的相关文件，用于数据库操作。
• public/: 存放公共静态文件，如图片、CSS 和 JavaScript 文件。
• src/: 包含项目的主要源代码。
• .dockerignore: 指定构建 Docker 镜像时需要排除的文件和目录。
• .gitignore: 指定 Git 忽略的文件和目录。
• CONTRIBUTING.md: 提供贡献指南，说明如何为项目贡献代码。
• Dockerfile: 用于构建 Docker 镜像的配置文件。
• LICENSE: 项目的许可文件，本项目采用 Apache-2.0 许可。
• README.md: 项目的自述文件，提供项目描述、功能、使用方法和贡献指南。
• astro.config.mjs: Astro 框架的配置文件。
• package-lock.json: npm 包的锁定文件，确保依赖的一致性。
• package.json: npm 包的配置文件，定义项目依赖和脚本。
• tailwind.config.mjs: Tailwind CSS 的配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 package.json 中的脚本进行。

• start: 用于启动开发服务器。
• build: 用于构建生产环境的静态文件。
• serve: 用于在生产环境中启动静态文件服务器。

通常情况下，使用以下命令启动开发服务器：

npm start

3. 项目的配置文件介绍

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

• .env: 环境变量配置文件，用于定义项目的环境变量，如 JWT_SECRET、ENCRYPTION_SECRET 等。
• astro.config.mjs: Astro 框架的配置文件，可以在这里配置路由、布局等。
• tailwind.config.mjs: Tailwind CSS 的配置文件，用于定制化 Tailwind 的行为。

确保在启动项目之前，正确设置 .env 文件中的环境变量，以保障项目的安全和正常运行。例如：

JWT_SECRET=your_secret_here
ENCRYPTION_SECRET=your_32_character_secret_here

以上为 GitSave 项目的目录结构、启动文件和配置文件的简要介绍。希望对您的使用和配置有所帮助。