SkyBlock Stats 项目启动与配置教程

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

SkyBlock Stats 项目是一个开源的 SkyBlock 个人资料查看器，它允许玩家分享他们在 Hypixel 服务器上的 SkyBlock 资料卡。以下是项目的目录结构及其简要介绍：

• .github/: 包含 GitHub 工作流程和资助信息的目录。
• includes/: 包含项目中的可复用模块和组件。
• misc/: 存放一些杂项文件，如统计数据和日志。
• public/: 包含静态文件，如网站图标和图片。
• resources/renders/: 存储与渲染相关的资源。
• src/: 项目的核心代码目录，包含 JavaScript 源文件。
• views/: 包含网页模板文件。
• .gitignore: 指定哪些文件和目录应该被 Git 忽略。
• LICENSE: 项目的 MIT 许可证文件。
• README.md: 项目的说明文件，包含项目信息和安装指南。
• credentials.json: 存储敏感配置信息的文件，如 Hypixel API Key。
• gitpod.yml: 用于 Gitpod 的配置文件。
• index.js: 项目的入口文件。
• init.js: 包含初始化配置的脚本。
• logo.gvdesign: 项目徽标的图形文件。
• package-lock.json: npm 依赖项的锁定文件。
• package.json: 项目的 npm 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 index.js，它是 Node.js 应用程序的入口点。以下是 index.js 文件的主要功能：

• 初始化和配置 Express 应用程序。
• 连接到 MongoDB 数据库和 Redis 缓存。
• 设置路由和中间件。
• 启动服务器并监听指定端口。

// 示例代码片段，非完整文件
const express = require('express');
const app = express();

// 设置中间件
app.use(express.json());

// 路由设置
app.use('/api', require('./src/routes/api'));

// 启动服务器
const PORT = process.env.PORT || 32464;
app.listen(PORT, () => {
    console.log(`Server running on port ${PORT}`);
});

3. 项目的配置文件介绍

项目的配置文件是 credentials.json，它包含了敏感配置信息，如 Hypixel API Key。这个文件不应该被提交到版本控制系统中。以下是一个 credentials.json 文件的示例：

{
    "hypixelApiKey": "YOUR_HYPIXEL_API_KEY"
}

在运行项目之前，你需要将 YOUR_HYPIXEL_API_KEY 替换为你在 Hypixel 服务器上获取的有效 API Key。确保不要将此文件分享给他人，因为它包含了敏感信息。

确保配置正确后，你可以通过运行 npm start 命令来启动项目，然后通过浏览器访问 http://localhost:32464 来查看你的 SkyBlock Stats 网站。