《TouchGAL 项目安装与配置指南》
1. 项目基础介绍
TouchGAL 是一个一站式的 Galgame(Galge,Gal Game,即女孩游戏)文化社区。该项目致力于为 Galgame 爱好者提供一个纯净的分享平台,提供论坛交流、游戏下载等服务。TouchGAL 项目采用 TypeScript 作为主要编程语言,同时使用了 JavaScript 和 MDX。
2. 项目使用的关键技术和框架
- TypeScript:一种由微软开发的开源编程语言,它是 JavaScript 的一个超集,添加了静态类型选项。
- Next.js:一个基于 React 的框架,用于构建服务器端渲染或静态生成的网页应用。
- Prisma:一个数据库工具集,可以帮助开发者轻松使用数据库。
- Tailwind CSS:一个功能类优先的 CSS 框架,用于快速UI开发。
- JWT(JSON Web Tokens):一种用于双方之间传递安全可靠信息的简洁的、URL安全的表达方式。
- Redis:一个开源的使用 ANSI C 编写的内存数据结构存储系统,用作数据库、缓存和消息中间件。
- PostgreSQL:一个功能强大的开源对象-关系型数据库系统。
3. 项目安装和配置的准备工作
在开始安装之前,请确保您的系统中已安装以下软件:
- Node.js
- pnpm(一种快速的、节省磁盘空间的包管理工具)
- PostgreSQL
- Redis
详细安装步骤
步骤 1:克隆项目
首先,使用 Git 克隆项目到本地目录:
git clone https://github.com/KUN1007/kun-touchgal-next.git
cd kun-touchgal-next
步骤 2:设置环境变量
在项目根目录下,参考 .env.example
文件,创建一个新的 .env
文件,并填写相应的环境变量。以下是一些基本的环境变量配置示例:
KUN_DATABASE_URL=postgresql://username:password@localhost:5432/touchgal?schema=public
KUN_VISUAL_NOVEL_SITE_URL=https://www.touchgal.io
NEXT_PUBLIC_KUN_PATCH_ADDRESS_DEV=http://127.0.0.1:3000
NEXT_PUBLIC_KUN_PATCH_ADDRESS_PROD=https://image.touchgal.moyu.moe
REDIS_HOST=127.0.0.1
REDIS_PORT=6379
JWT_ISS=touchgal
JWT_AUD=touchgal_admin
JWT_SECRET=your_secret_key
NODE_ENV=development
步骤 3:初始化数据库
使用 Prisma 来创建和迁移数据库:
pnpm prisma:generate
pnpm prisma:migrate dev --create-only
步骤 4:安装依赖
安装项目所需的依赖:
pnpm install
步骤 5:启动项目
现在,您可以启动开发服务器:
pnpm dev
打开浏览器并访问 http://localhost:3000
,您应该能够看到 TouchGAL 项目运行。
请确保在每一步操作中都仔细检查任何错误信息,并根据需要调整配置。如果遇到问题,可以参考项目的官方文档或加入开发群组寻求帮助。