Deft 项目教程

1. 项目目录结构及介绍

Deft 项目的目录结构如下：

deft/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── routes.js
├── config/
│   ├── database.js
│   ├── environment.js
│   └── routes.js
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── test/
│   ├── unit/
│   └── integration/
├── .gitignore
├── package.json
├── README.md
└── server.js

目录结构介绍

• app/: 包含应用程序的主要代码。

  • controllers/: 存放控制器文件，负责处理业务逻辑。
  • models/: 存放模型文件，负责与数据库交互。
  • views/: 存放视图文件，负责渲染页面。
  • routes.js: 定义应用程序的路由。

• config/: 包含项目的配置文件。

  • database.js: 数据库配置文件。
  • environment.js: 环境配置文件。
  • routes.js: 路由配置文件。

• public/: 存放静态资源文件。

  • css/: 存放样式文件。
  • js/: 存放JavaScript文件。
  • images/: 存放图片文件。

• test/: 存放测试文件。

  • unit/: 单元测试文件。
  • integration/: 集成测试文件。

• .gitignore: Git忽略文件，指定不需要版本控制的文件和目录。

• package.json: 项目的依赖管理文件。

• README.md: 项目说明文件。

• server.js: 项目的启动文件。

2. 项目的启动文件介绍

项目的启动文件是 server.js。该文件负责启动应用程序，并配置服务器的基本设置。

server.js 文件内容

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

// 设置静态文件目录
app.use(express.static('public'));

// 加载路由配置
routes(app);

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

启动文件功能介绍

• 引入依赖: 引入了 express 框架、配置文件 environment.js 和路由配置文件 routes.js。
• 设置静态文件目录: 使用 express.static 方法设置静态文件目录为 public。
• 加载路由配置: 调用 routes(app) 方法加载路由配置。
• 启动服务器: 使用 app.listen 方法启动服务器，监听配置文件中指定的端口。

3. 项目的配置文件介绍

项目的配置文件主要存放在 config/ 目录下，包括数据库配置、环境配置和路由配置。

config/database.js

module.exports = {
  development: {
    username: 'root',
    password: 'password',
    database: 'deft_dev',
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  test: {
    username: 'root',
    password: 'password',
    database: 'deft_test',
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  production: {
    username: 'root',
    password: 'password',
    database: 'deft_prod',
    host: '127.0.0.1',
    dialect: 'mysql'
  }
};

config/environment.js

module.exports = {
  port: process.env.PORT || 3000,
  environment: process.env.NODE_ENV || 'development'
};

config/routes.js

module.exports = (app) => {
  app.get('/', (req, res) => {
    res.send('Hello World!');
  });

  app.use('/api', require('../app/routes/api'));
};

配置文件功能介绍

• database.js: 定义了不同环境下的数据库配置，包括开发环境、测试环境和生产环境。
• environment.js: 定义了应用程序的端口和运行环境。
• routes.js: 定义了应用程序的路由配置，包括根路径和API路由。

通过这些配置文件，可以灵活地管理应用程序的不同环境和路由设置。