Bruno 开源项目使用教程

Bruno 开源项目使用教程

brunoA base API controller for Laravel that gives sorting, filtering, eager loading and pagination for your resources项目地址:https://gitcode.com/gh_mirrors/brun/bruno

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

bruno/
├── bin/
│   └── bruno
├── config/
│   ├── default.json
│   ├── development.json
│   └── production.json
├── src/
│   ├── commands/
│   ├── lib/
│   └── index.js
├── test/
│   └── integration/
├── .gitignore
├── .eslintrc.json
├── package.json
└── README.md

• bin/: 包含可执行文件。
• config/: 包含项目的配置文件，如默认配置、开发环境和生产环境配置。
• src/: 源代码目录，包含命令、库和入口文件。
• test/: 测试目录，包含集成测试。
• .gitignore: Git 忽略文件列表。
• .eslintrc.json: ESLint 配置文件。
• package.json: 项目依赖和脚本配置。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件位于 src/index.js。这个文件是整个应用的入口点，负责初始化应用并启动服务。

// src/index.js
const app = require('./lib/app');
const config = require('../config');

app.start(config);

3. 项目的配置文件介绍

配置文件位于 config/ 目录下，包含以下文件：

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

示例 default.json:

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 5432,
    "name": "bruno"
  }
}

示例 development.json:

{
  "database": {
    "host": "dev-db.example.com"
  }
}

示例 production.json:

{
  "port": 8080,
  "database": {
    "host": "prod-db.example.com"
  }
}

这些配置文件通过 config 模块加载，确保应用在不同环境下使用正确的配置。

brunoA base API controller for Laravel that gives sorting, filtering, eager loading and pagination for your resources项目地址:https://gitcode.com/gh_mirrors/brun/bruno