AwesomeGithub 项目教程

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

AwesomeGithub/
├── README.md
├── .gitignore
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── routes/
│   │   ├── index.js
│   ├── controllers/
│   │   ├── homeController.js
│   ├── models/
│   │   ├── userModel.js
│   ├── utils/
│   │   ├── logger.js

• README.md: 项目说明文件。
• .gitignore: Git忽略文件配置。
• package.json: 项目依赖和脚本配置。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: 路由文件目录。
    • index.js: 路由入口文件。
  • controllers/: 控制器文件目录。
    • homeController.js: 主页控制器文件。
  • models/: 数据模型文件目录。
    • userModel.js: 用户模型文件。
  • utils/: 工具文件目录。
    • logger.js: 日志工具文件。

2. 项目的启动文件介绍

项目启动文件为 src/index.js，其主要功能是初始化应用并启动服务器。以下是简要代码示例：

const express = require('express');
const app = express();
const config = require('./config');
const routes = require('./routes');

app.use('/', routes);

app.listen(config.port, () => {
  console.log(`Server is running on port ${config.port}`);
});

• 引入 express 模块创建应用实例。
• 引入配置文件和路由文件。
• 使用路由文件配置路由。
• 启动服务器并监听配置文件中指定的端口。

3. 项目的配置文件介绍

项目配置文件位于 src/config/ 目录下，主要包括 default.json 和 production.json 两个文件。

default.json

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "user": "root",
    "password": "",
    "database": "awesome_github"
  }
}

• port: 服务器监听端口。
• database: 数据库连接配置。

production.json

{
  "port": 8080,
  "database": {
    "host": "production_host",
    "user": "production_user",
    "password": "production_password",
    "database": "awesome_github_production"
  }
}

• port: 生产环境服务器监听端口。
• database: 生产环境数据库连接配置。

配置文件通过 config 模块加载，根据环境变量选择相应的配置文件。