Peek 项目使用教程

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

Peek 项目的目录结构如下：

Peek/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── routes/
│   │   ├── index.js
│   ├── models/
│   │   ├── user.js
│   ├── controllers/
│   │   ├── userController.js
│   ├── utils/
│   │   ├── helper.js
├── public/
│   ├── index.html
├── tests/
│   ├── user.test.js

目录结构介绍

• README.md: 项目说明文件。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: 路由文件目录。
    • index.js: 路由入口文件。
  • models/: 数据模型文件目录。
    • user.js: 用户模型文件。
  • controllers/: 控制器文件目录。
    • userController.js: 用户控制器文件。
  • utils/: 工具函数文件目录。
    • helper.js: 辅助函数文件。
• public/: 静态资源目录。
  • index.html: 主页文件。
• tests/: 测试文件目录。
  • user.test.js: 用户相关测试文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。这个文件是整个项目的入口点，负责初始化应用并启动服务器。

src/index.js 文件内容概览

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

app.use(express.json());
app.use('/api', routes);

const PORT = process.env.PORT || 3000;

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

启动文件功能介绍

• 引入 express 模块并创建应用实例。
• 引入配置文件和路由文件。
• 使用中间件处理 JSON 请求。
• 挂载路由到 /api 路径。
• 监听指定端口启动服务器。

3. 项目的配置文件介绍

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

default.json 文件内容概览

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

production.json 文件内容概览

{
  "port": 8080,
  "db": {
    "host": "production-db-host",
    "user": "prod-user",
    "password": "prod-password",
    "database": "peek_prod"
  }
}

配置文件功能介绍

• default.json: 包含默认的配置信息，如开发环境的端口和数据库连接信息。
• production.json: 包含生产环境的配置信息，如生产环境的端口和数据库连接信息。

通过这些配置文件，可以方便地在不同环境下切换配置，确保应用在不同环境下的正常运行。