Grandjs 项目教程

Grandjs 项目教程

grandjsA backend framework for solid web apps based on node.js项目地址:https://gitcode.com/gh_mirrors/gr/grandjs

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

grandjs/
├── src/
│   ├── controllers/
│   ├── middlewares/
│   ├── routes/
│   ├── utils/
│   └── index.ts
├── config/
│   ├── default.json
│   ├── production.json
│   └── development.json
├── package.json
├── tsconfig.json
└── README.md

• src/: 包含项目的源代码。
  • controllers/: 存放控制器文件，处理业务逻辑。
  • middlewares/: 存放中间件文件，处理请求前后的逻辑。
  • routes/: 存放路由文件，定义API路由。
  • utils/: 存放工具函数文件，提供通用功能。
  • index.ts: 项目的入口文件。
• config/: 包含项目的配置文件。
  • default.json: 默认配置文件。
  • production.json: 生产环境配置文件。
  • development.json: 开发环境配置文件。
• package.json: 项目的依赖管理文件。
• tsconfig.json: TypeScript 配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts。该文件主要负责以下任务：

• 导入必要的模块和配置。
• 初始化应用实例。
• 加载中间件。
• 定义路由。
• 启动服务器。

import { Server } from "grandjs";
import { config } from "../config";
import { routes } from "./routes";

const app = new Server();

app.use(middlewares);
app.addRoutes(routes);

app.listen(config.port, () => {
  console.log(`Server is running on port ${config.port}`);
});

3. 项目的配置文件介绍

项目的配置文件存放在 config/ 目录下，主要包括 default.json、production.json 和 development.json。

• default.json: 默认配置文件，包含所有环境通用的配置。
• production.json: 生产环境配置文件，覆盖默认配置中的某些项。
• development.json: 开发环境配置文件，覆盖默认配置中的某些项。

示例 default.json:

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 27017,
    "name": "grandjs"
  }
}

示例 production.json:

{
  "port": 8080,
  "database": {
    "host": "prod-db-host",
    "port": 27017,
    "name": "grandjs-prod"
  }
}

示例 development.json:

{
  "port": 3001,
  "database": {
    "host": "dev-db-host",
    "port": 27017,
    "name": "grandjs-dev"
  }
}

通过这些配置文件，可以方便地管理不同环境下的配置，确保项目在不同环境下都能正常运行。

grandjsA backend framework for solid web apps based on node.js项目地址:https://gitcode.com/gh_mirrors/gr/grandjs