Cockatiel 项目使用文档
1. 项目的目录结构及介绍
cockatiel/
├── src/
│ ├── index.ts
│ ├── config/
│ │ ├── default.json
│ │ ├── production.json
│ ├── utils/
│ │ ├── logger.ts
│ ├── modules/
│ │ ├── user/
│ │ │ ├── controller.ts
│ │ │ ├── service.ts
│ ├── app.ts
├── package.json
├── README.md
- src/: 源代码目录。
- index.ts: 项目的入口文件。
- config/: 配置文件目录。
- default.json: 默认配置文件。
- production.json: 生产环境配置文件。
- utils/: 工具函数目录。
- logger.ts: 日志工具。
- modules/: 模块目录,包含各个业务模块。
- user/: 用户模块。
- controller.ts: 用户控制器。
- service.ts: 用户服务。
- user/: 用户模块。
- app.ts: 应用主文件。
- package.json: 项目依赖和脚本配置文件。
- README.md: 项目说明文档。
2. 项目的启动文件介绍
项目的启动文件是 src/index.ts
。该文件主要负责初始化应用并启动服务器。以下是 index.ts
的主要内容:
import app from './app';
import config from './config';
const { port } = config;
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});
- 导入应用主文件
app.ts
。 - 导入配置文件
config
。 - 启动服务器并监听配置文件中指定的端口。
3. 项目的配置文件介绍
项目的配置文件位于 src/config/
目录下,主要包括 default.json
和 production.json
。
default.json
默认配置文件,包含开发环境的配置信息:
{
"port": 3000,
"database": {
"host": "localhost",
"port": 5432,
"name": "dev_db"
}
}
production.json
生产环境配置文件,包含生产环境的配置信息:
{
"port": 8080,
"database": {
"host": "prod_db_host",
"port": 5432,
"name": "prod_db"
}
}
配置文件通过环境变量加载,确保不同环境下的配置信息正确加载。