开源项目 Yerba 使用教程
1. 项目的目录结构及介绍
yerba/
├── src/
│ ├── main.js
│ ├── config/
│ │ ├── default.json
│ │ ├── production.json
│ ├── routes/
│ │ ├── index.js
│ ├── models/
│ │ ├── User.js
├── package.json
├── README.md
src/
: 项目的源代码目录。main.js
: 项目的入口文件。config/
: 配置文件目录。default.json
: 默认配置文件。production.json
: 生产环境配置文件。
routes/
: 路由文件目录。index.js
: 路由定义文件。
models/
: 数据模型文件目录。User.js
: 用户模型文件。
package.json
: 项目依赖和脚本配置文件。README.md
: 项目说明文档。
2. 项目的启动文件介绍
src/main.js
是项目的入口文件,负责启动应用。以下是该文件的主要内容:
const express = require('express');
const app = express();
const config = require('./config');
app.use('/', require('./routes'));
const port = process.env.PORT || 3000;
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});
- 引入
express
框架并创建应用实例。 - 加载配置文件。
- 使用路由文件。
- 监听指定端口启动服务器。
3. 项目的配置文件介绍
src/config/
目录下包含两个配置文件:
default.json
{
"port": 3000,
"db": {
"host": "localhost",
"user": "root",
"password": "",
"database": "yerba"
}
}
port
: 默认端口号。db
: 数据库连接配置。
production.json
{
"port": 8080,
"db": {
"host": "production-db-host",
"user": "prod_user",
"password": "prod_password",
"database": "yerba_prod"
}
}
port
: 生产环境端口号。db
: 生产环境数据库连接配置。
这两个配置文件分别用于开发和生产环境,通过环境变量加载不同的配置文件。