CarteJaune 开源项目教程

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

CarteJaune/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── routes/
│   │   ├── api.js
│   ├── models/
│   │   ├── User.js
│   ├── controllers/
│   │   ├── userController.js
│   ├── middleware/
│   │   ├── auth.js
├── public/
│   ├── index.html
│   ├── styles.css
├── tests/
│   ├── user.test.js

目录结构介绍

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• package.json: 项目的依赖管理文件，包含项目的依赖包和脚本命令。
• src/: 项目的源代码目录。
  • index.js: 项目的入口文件。
  • config/: 项目的配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: 路由文件目录。
    • api.js: API 路由文件。
  • models/: 数据模型文件目录。
    • User.js: 用户模型文件。
  • controllers/: 控制器文件目录。
    • userController.js: 用户控制器文件。
  • middleware/: 中间件文件目录。
    • auth.js: 认证中间件文件。
• public/: 静态文件目录。
  • index.html: 主页文件。
  • styles.css: 样式文件。
• tests/: 测试文件目录。
  • user.test.js: 用户相关测试文件。

2. 项目的启动文件介绍

src/index.js

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

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

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

启动文件介绍

• express: 引入 Express 框架。
• app: 创建 Express 应用实例。
• config: 引入配置文件。
• routes: 引入路由文件。
• app.use(express.json()): 使用 JSON 中间件解析请求体。
• app.use('/api', routes): 挂载 API 路由。
• app.listen(PORT, ...): 启动服务器，监听指定端口。

3. 项目的配置文件介绍

src/config/default.json

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 27017,
    "name": "cartejaune"
  }
}

src/config/production.json

{
  "port": 8080,
  "database": {
    "host": "production-db-host",
    "port": 27017,
    "name": "cartejaune-production"
  }
}

配置文件介绍

• default.json: 默认配置文件，包含开发环境的配置信息。

  • port: 服务器监听端口。
  • database: 数据库配置。
    • host: 数据库主机地址。
    • port: 数据库端口。
    • name: 数据库名称。

• production.json: 生产环境配置文件，包含生产环境的配置信息。

  • port: 生产环境服务器监听端口。
  • database: 生产环境数据库配置。
    • host: 生产环境数据库主机地址。
    • port: 生产环境数据库端口。
    • name: 生产环境数据库名称。

通过以上配置文件，可以根据不同的环境（开发、生产）加载相应的配置信息，确保项目在不同环境下的正常运行。