Jet 项目使用教程
1. 项目的目录结构及介绍
jet/
├── README.md
├── package.json
├── src/
│ ├── index.js
│ ├── config/
│ │ ├── default.json
│ │ ├── production.json
│ ├── routes/
│ │ ├── index.js
│ ├── controllers/
│ │ ├── userController.js
│ ├── models/
│ │ ├── userModel.js
├── public/
│ ├── index.html
│ ├── css/
│ ├── js/
- README.md: 项目说明文件。
- package.json: 项目依赖和脚本配置文件。
- src/: 源代码目录。
- index.js: 项目入口文件。
- config/: 配置文件目录。
- default.json: 默认配置文件。
- production.json: 生产环境配置文件。
- routes/: 路由文件目录。
- index.js: 路由入口文件。
- controllers/: 控制器文件目录。
- userController.js: 用户控制器文件。
- models/: 模型文件目录。
- userModel.js: 用户模型文件。
- public/: 静态资源目录。
- index.html: 主页文件。
- css/: CSS 文件目录。
- js/: JavaScript 文件目录。
2. 项目的启动文件介绍
src/index.js 是项目的启动文件,负责初始化应用并启动服务器。以下是该文件的主要内容:
const express = require('express');
const app = express();
const config = require('./config/default.json');
// 引入路由
const routes = require('./routes');
// 设置中间件
app.use(express.json());
app.use(express.urlencoded({ extended: true }));
// 使用路由
app.use('/', routes);
// 启动服务器
const PORT = process.env.PORT || config.port;
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": "jet"
}
}
production.json
{
"port": 8080,
"db": {
"host": "production-db-host",
"user": "prod-user",
"password": "prod-password",
"database": "jet_prod"
}
}
- port: 服务器端口号。
- db: 数据库配置信息,包括主机、用户名、密码和数据库名。
这些配置文件可以根据不同的环境(如开发环境和生产环境)进行不同的配置。