Punchcard 项目教程

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

punchcard/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── models/
│   ├── routes/
│   ├── services/
│   ├── utils/
├── test/
├── .gitignore
├── .eslintrc.json
├── .prettierrc
└── yarn.lock

目录结构介绍

• README.md: 项目的基本介绍和使用说明。
• package.json: 项目的依赖管理文件，包含项目的依赖包和脚本命令。
• src/: 项目的源代码目录。
  • index.js: 项目的入口文件。
  • config/: 项目的配置文件目录，包含不同环境的配置文件。
  • models/: 存放数据模型的文件。
  • routes/: 存放路由定义的文件。
  • services/: 存放业务逻辑服务的文件。
  • utils/: 存放工具函数的文件。
• test/: 存放测试文件的目录。
• .gitignore: Git 忽略文件列表。
• .eslintrc.json: ESLint 配置文件。
• .prettierrc: Prettier 代码格式化配置文件。
• yarn.lock: Yarn 依赖锁定文件。

2. 项目的启动文件介绍

src/index.js

index.js 是项目的入口文件，负责启动应用程序。以下是该文件的主要内容：

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

app.use(express.json());

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

// 启动服务器
const port = config.get('port');
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

启动文件介绍

• 引入依赖: 引入了 express 框架和配置模块。
• 创建应用实例: 使用 express() 创建应用实例 app。
• 加载中间件: 使用 express.json() 解析 JSON 请求体。
• 加载路由: 通过 require('./routes')(app) 加载路由配置。
• 启动服务器: 根据配置文件中的端口启动服务器，并在控制台输出启动信息。

3. 项目的配置文件介绍

src/config/default.json

default.json 是项目的默认配置文件，包含所有环境的通用配置。

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 5432,
    "name": "punchcard"
  }
}

src/config/production.json

production.json 是生产环境的配置文件，会覆盖 default.json 中的相应配置。

{
  "port": 8080,
  "database": {
    "host": "production-db.example.com",
    "port": 5432,
    "name": "punchcard_production"
  }
}

配置文件介绍

• port: 服务器监听的端口。
• database: 数据库配置，包含主机地址、端口和数据库名称。

配置文件通过 config 模块加载，可以根据环境变量选择不同的配置文件。例如，在生产环境中，production.json 的配置会覆盖 default.json 中的配置。