Gladius Core 开源项目使用教程

1. 项目目录结构及介绍

Gladius Core 项目的目录结构如下：

gladius-core/
├── bin/
│   └── gladius-core
├── config/
│   ├── config.json
│   └── ...
├── src/
│   ├── main.js
│   ├── utils/
│   └── ...
├── test/
│   └── ...
├── .gitignore
├── package.json
├── README.md
└── ...

目录结构介绍

• bin/: 存放可执行文件，如 gladius-core。
• config/: 存放项目的配置文件，如 config.json。
• src/: 存放项目的源代码，main.js 是项目的入口文件。
• test/: 存放项目的测试代码。
• .gitignore: Git 忽略文件列表。
• package.json: 项目的依赖管理文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/main.js。该文件是整个项目的入口点，负责初始化项目并启动服务。

src/main.js 文件内容概览

const express = require('express');
const config = require('../config/config.json');
const utils = require('./utils');

const app = express();

app.get('/', (req, res) => {
    res.send('Hello, Gladius Core!');
});

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

启动文件功能介绍

• 引入依赖: 引入了 express 框架、配置文件 config.json 以及自定义的工具函数。
• 创建 Express 应用: 使用 express() 创建了一个应用实例。
• 定义路由: 定义了一个简单的路由 /，当访问根路径时返回 "Hello, Gladius Core!"。
• 启动服务: 根据配置文件中的端口号启动服务器。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.json。该文件包含了项目的各种配置参数。

config/config.json 文件内容概览

{
    "port": 3000,
    "database": {
        "host": "localhost",
        "port": 5432,
        "name": "gladius_db"
    },
    "logging": {
        "level": "info",
        "file": "gladius.log"
    }
}

配置文件参数介绍

• port: 服务器监听的端口号，默认为 3000。
• database: 数据库配置，包括主机地址 host、端口号 port 和数据库名称 name。
• logging: 日志配置，包括日志级别 level 和日志文件路径 file。

通过以上配置文件，可以灵活地调整项目的运行参数，满足不同的部署需求。