TouchGal开源项目使用教程

TouchGal开源项目使用教程

kun-touchgal-next TouchGAL是立足于分享快乐的一站式Galgame文化社区, 为Gal爱好者提供一片净土! 项目地址: https://gitcode.com/gh_mirrors/ku/kun-touchgal-next

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

TouchGal 是一个基于 Next.js 的开源 Galgame 文化社区项目。以下是项目的目录结构及其说明：

• app: 项目的主要应用目录，包含了页面和组件。
• components: 可复用的 React 组件。
• config: 配置文件目录。
• constants: 常量定义。
• hooks: 自定义 React Hooks。
• lib: 项目库文件。
• middleware: 中间件目录。
• migration: 数据库迁移脚本。
• motion: 动画相关文件。
• posts: 文章和动态目录。
• prisma: Prisma 数据库工具相关文件。
• public: 公共文件目录，如图片、CSS、字体等。
• scripts: 脚本文件目录。
• server: 服务器端代码。
• store: 状态管理。
• styles: 样式文件目录。
• types: 类型定义。
• utils: 工具函数。
• .editorconfig: 编辑器配置文件。
• .eslintrc.json: ESLint 配置文件。
• .gitignore: Git 忽略文件。
• .npmrc: npm 配置文件。
• .prettierrc.json: Prettier 配置文件。
• LICENSE: 开源协议文件。
• README.md: 项目说明文件。
• ecosystem.config.js: PM2 配置文件。
• middleware.ts: 中间件 TypeScript 文件。
• next.config.ts: Next.js 配置文件。
• package.json: 项目依赖和脚本。
• pnpm-lock.yaml: PNPM 锁文件。
• postcss.config.js: PostCSS 配置文件。
• tailwind.config.js: Tailwind CSS 配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动主要通过 package.json 文件中的脚本实现：

• pnpm dev: 启动开发服务器，通常用于本地开发。
• pnpm build: 构建项目，用于生成生产环境的静态文件。
• pnpm start: 启动生产环境的服务器。

在开发环境下，执行 pnpm dev 后，Next.js 将启动一个热重载的开发服务器。

3. 项目的配置文件介绍

项目的配置文件主要包括以下几个：

• .env.example: 环境变量配置示例文件，用于本地开发时参考。
• config: 配置目录，可能包含不同的配置文件，如数据库配置等。
• next.config.ts: Next.js 的配置文件，用于定制 Next.js 的行为。
• tailwind.config.js: Tailwind CSS 的配置文件，用于定制 Tailwind 的样式。

.env.example 文件中包含了一些基本的环境变量，例如数据库连接字符串、邮件服务配置、S3 存储配置等。在实际部署时，需要根据实际情况创建一个 .env 文件，并填入正确的环境变量值。

kun-touchgal-next TouchGAL是立足于分享快乐的一站式Galgame文化社区, 为Gal爱好者提供一片净土! 项目地址: https://gitcode.com/gh_mirrors/ku/kun-touchgal-next