REKit 项目教程
1. 项目的目录结构及介绍
REKit/
├── README.md
├── package.json
├── src/
│ ├── index.js
│ ├── config/
│ │ ├── default.json
│ │ ├── production.json
│ ├── models/
│ ├── routes/
│ ├── controllers/
│ ├── services/
│ ├── utils/
├── public/
│ ├── index.html
│ ├── css/
│ ├── js/
│ ├── images/
README.md
: 项目说明文件。package.json
: 项目依赖和脚本配置文件。src/
: 源代码目录。index.js
: 项目入口文件。config/
: 配置文件目录。default.json
: 默认配置文件。production.json
: 生产环境配置文件。
models/
: 数据模型目录。routes/
: 路由定义目录。controllers/
: 控制器目录。services/
: 服务目录。utils/
: 工具函数目录。
public/
: 静态资源目录。index.html
: 主页文件。css/
: CSS 文件目录。js/
: JavaScript 文件目录。images/
: 图片文件目录。
2. 项目的启动文件介绍
src/index.js
是项目的启动文件,负责初始化应用和服务器。以下是简要代码示例:
const express = require('express');
const app = express();
const config = require('./config');
app.use(express.json());
app.use(express.urlencoded({ extended: true }));
// 路由定义
const routes = require('./routes');
app.use('/api', routes);
const PORT = config.port || 3000;
app.listen(PORT, () => {
console.log(`Server is running on port ${PORT}`);
});
3. 项目的配置文件介绍
src/config/
目录下包含项目的配置文件,主要有 default.json
和 production.json
。
default.json
{
"port": 3000,
"db": {
"host": "localhost",
"user": "root",
"password": "",
"database": "rekit"
}
}
production.json
{
"port": 8080,
"db": {
"host": "production-db-host",
"user": "prod-user",
"password": "prod-password",
"database": "rekit_prod"
}
}
配置文件通过环境变量加载,确保不同环境下的配置分离。