Mercury 开源项目使用教程

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

mercury/
├── bin/
│   └── mercury.sh
├── config/
│   ├── default.conf
│   └── production.conf
├── docs/
│   └── README.md
├── lib/
│   ├── mercury_core.rb
│   └── mercury_utils.rb
├── public/
│   ├── index.html
│   └── styles.css
├── spec/
│   └── mercury_spec.rb
├── Gemfile
├── Gemfile.lock
└── README.md

目录结构介绍

• bin/: 存放项目的启动脚本，如 mercury.sh。
• config/: 存放项目的配置文件，如 default.conf 和 production.conf。
• docs/: 存放项目的文档文件，如 README.md。
• lib/: 存放项目的核心代码文件，如 mercury_core.rb 和 mercury_utils.rb。
• public/: 存放项目的静态文件，如 index.html 和 styles.css。
• spec/: 存放项目的测试文件，如 mercury_spec.rb。
• Gemfile: 项目的依赖管理文件。
• Gemfile.lock: 项目依赖的锁定文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

bin/mercury.sh

bin/mercury.sh 是项目的启动脚本。该脚本负责初始化环境、加载配置文件并启动项目。以下是启动脚本的基本内容：

#!/bin/bash

# 设置环境变量
export MERCURY_ENV=production

# 加载配置文件
source config/production.conf

# 启动项目
ruby lib/mercury_core.rb

启动步骤

1. 设置环境变量: 通过 export MERCURY_ENV=production 设置项目运行环境。
2. 加载配置文件: 通过 source config/production.conf 加载项目的配置文件。
3. 启动项目: 通过 ruby lib/mercury_core.rb 启动项目的主程序。

3. 项目的配置文件介绍

config/default.conf

config/default.conf 是项目的默认配置文件，包含项目的通用配置项。以下是配置文件的基本内容：

# 数据库配置
database_url="postgres://user:password@localhost/mercury_db"

# 日志级别
log_level="info"

# 端口配置
port=3000

config/production.conf

config/production.conf 是项目的生产环境配置文件，包含生产环境特有的配置项。以下是配置文件的基本内容：

# 数据库配置
database_url="postgres://prod_user:prod_password@prod_host/mercury_db"

# 日志级别
log_level="error"

# 端口配置
port=8080

配置文件说明

• database_url: 数据库连接字符串，指定数据库的连接信息。
• log_level: 日志级别，控制日志输出的详细程度。
• port: 项目运行的端口号，指定项目在哪个端口上运行。

通过以上配置文件，可以根据不同的环境（如开发环境、测试环境、生产环境）灵活配置项目的运行参数。