Gistblog 项目教程

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

Gistblog 项目的目录结构如下：

gistblog/
├── models/
├── public/
├── routes/
├── views/
├── .gitignore
├── LICENSE
├── Procfile
├── README.md
├── app.js
├── config.js
├── exports-sample.txt
├── gh-api.js
└── package.json

目录结构介绍：

• models/: 存放项目的数据模型文件。
• public/: 存放静态资源文件，如 CSS、JavaScript 等。
• routes/: 存放项目的路由文件，定义了不同 URL 路径的处理逻辑。
• views/: 存放项目的视图文件，通常是 HTML 模板文件。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• LICENSE: 项目的开源许可证文件。
• Procfile: 用于 Heroku 部署的配置文件。
• README.md: 项目的说明文档。
• app.js: 项目的启动文件。
• config.js: 项目的配置文件。
• exports-sample.txt: 配置文件的示例，包含需要设置的环境变量。
• gh-api.js: 与 GitHub API 交互的文件。
• package.json: 项目的依赖管理文件，包含项目的元数据和依赖包。

2. 项目的启动文件介绍

项目的启动文件是 app.js。该文件负责初始化应用程序，配置服务器，并启动应用程序。以下是 app.js 的主要内容：

// app.js
const express = require('express');
const app = express();
const config = require('./config');
const ghApi = require('./gh-api');

// 配置 Express 应用
app.set('view engine', 'ejs');
app.use(express.static('public'));

// 加载路由
app.use(require('./routes'));

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

启动文件介绍：

• 引入依赖: 引入了 express、config 和 gh-api 模块。
• 配置 Express 应用: 设置了视图引擎为 ejs，并指定了静态资源目录为 public。
• 加载路由: 使用 app.use 加载了项目的路由文件。
• 启动服务器: 监听指定端口（默认 3000），启动服务器。

3. 项目的配置文件介绍

项目的配置文件是 config.js。该文件包含了应用程序的各种配置项，如数据库连接、GitHub API 配置等。以下是 config.js 的主要内容：

// config.js
module.exports = {
  github: {
    clientID: process.env.GITHUB_CLIENT_ID,
    clientSecret: process.env.GITHUB_CLIENT_SECRET,
    callbackURL: process.env.GITHUB_CALLBACK_URL
  },
  sessionSecret: process.env.SESSION_SECRET,
  mongo: {
    uri: process.env.MONGO_URI
  },
  redis: {
    uri: process.env.REDIS_URI
  }
};

配置文件介绍：

• GitHub 配置: 包含 GitHub OAuth 的客户端 ID、客户端密钥和回调 URL。
• 会话密钥: 用于会话管理的密钥。
• MongoDB 配置: 包含 MongoDB 数据库的连接 URI。
• Redis 配置: 包含 Redis 数据库的连接 URI。

这些配置项通常通过环境变量来设置，以确保敏感信息不会被硬编码在代码中。