Trex 开源项目使用教程

Trex 开源项目使用教程

TrexPackage Manager for deno 🦕项目地址:https://gitcode.com/gh_mirrors/tre/Trex

1. 项目的目录结构及介绍

Trex/
├── assets/
│   ├── css/
│   ├── img/
│   └── js/
├── config/
│   └── config.json
├── src/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   └── index.ts
├── tests/
│   └── unit/
├── .gitignore
├── README.md
├── package.json
└── tsconfig.json

• assets/: 存放项目的静态资源，如CSS、图片和JavaScript文件。
• config/: 存放项目的配置文件，如config.json。
• src/: 项目的源代码目录，包含控制器、模型、路由等。
  • controllers/: 存放控制器文件。
  • models/: 存放模型文件。
  • routes/: 存放路由文件。
  • index.ts: 项目的入口文件。
• tests/: 存放测试文件，如单元测试。
• .gitignore: Git忽略文件配置。
• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript配置文件。

2. 项目的启动文件介绍

项目的启动文件是src/index.ts。该文件负责初始化应用、配置中间件、设置路由等。以下是index.ts的基本结构：

import { Application } from "https://deno.land/x/oak/mod.ts";
import { config } from "https://deno.land/x/dotenv/mod.ts";
import router from "./routes/index.ts";

const app = new Application();
const env = config();

app.use(router.routes());
app.use(router.allowedMethods());

console.log(`Server running on port ${env.PORT}`);
await app.listen({ port: Number(env.PORT) });

• 导入模块: 导入所需的模块，如Oak框架、环境变量配置等。
• 创建应用实例: 使用Oak框架创建应用实例。
• 配置环境变量: 读取并配置环境变量。
• 设置路由: 将路由注册到应用实例中。
• 启动服务器: 启动服务器并监听指定端口。

3. 项目的配置文件介绍

项目的配置文件位于config/config.json。该文件包含了项目运行所需的各种配置信息，如数据库连接、端口号等。以下是config.json的基本结构：

{
  "PORT": 8000,
  "DB_HOST": "localhost",
  "DB_PORT": 5432,
  "DB_USER": "user",
  "DB_PASSWORD": "password",
  "DB_NAME": "dbname"
}

• PORT: 服务器监听的端口号。
• DB_HOST: 数据库主机地址。
• DB_PORT: 数据库端口号。
• DB_USER: 数据库用户名。
• DB_PASSWORD: 数据库密码。
• DB_NAME: 数据库名称。

通过修改config.json文件，可以灵活地调整项目的运行配置。

TrexPackage Manager for deno 🦕项目地址:https://gitcode.com/gh_mirrors/tre/Trex