开源项目 Ham 使用教程

开源项目 Ham 使用教程

HamPHP Microframework项目地址:https://gitcode.com/gh_mirrors/ha/Ham

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

Ham/
├── bin/
│   └── ham
├── config/
│   ├── default.json
│   └── production.json
├── src/
│   ├── main.js
│   ├── utils/
│   │   └── helper.js
│   └── routes/
│       └── index.js
├── test/
│   └── main.test.js
├── package.json
└── README.md

• bin/: 存放可执行文件。
• config/: 存放配置文件，包括默认配置和生产环境配置。
• src/: 源代码目录，包含主文件和各个模块。
  • main.js: 项目启动文件。
  • utils/: 工具函数目录。
  • routes/: 路由配置目录。
• test/: 测试文件目录。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

src/main.js 是项目的启动文件，负责初始化应用和启动服务器。以下是启动文件的主要内容：

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

require('./routes')(app);

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

• 引入 express 模块创建应用实例。
• 加载配置文件 default.json。
• 引入并应用路由配置。
• 启动服务器并监听指定端口。

3. 项目的配置文件介绍

config/ 目录下包含两个配置文件：

• default.json: 默认配置文件，包含基础配置项。
• production.json: 生产环境配置文件，可以覆盖默认配置。

default.json

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

production.json

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

• port: 服务器监听的端口。
• database: 数据库连接配置，包括主机、端口和数据库名称。

以上是开源项目 Ham 的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

HamPHP Microframework项目地址:https://gitcode.com/gh_mirrors/ha/Ham