Charly 项目使用教程
1. 项目的目录结构及介绍
charly/
├── bin/
│ └── run.sh
├── config/
│ └── default.yaml
├── src/
│ ├── main.ch
│ ├── utils/
│ │ └── helpers.ch
│ └── modules/
│ └── core.ch
├── tests/
│ └── test_main.ch
├── README.md
└── LICENSE
- bin/: 包含项目的启动脚本。
- config/: 包含项目的配置文件。
- src/: 包含项目的主要源代码。
- main.ch: 项目的入口文件。
- utils/: 包含各种工具函数。
- modules/: 包含核心模块。
- tests/: 包含项目的测试文件。
- README.md: 项目说明文档。
- LICENSE: 项目许可证。
2. 项目的启动文件介绍
项目的启动文件位于 bin/run.sh
。该脚本负责初始化环境并启动项目。以下是 run.sh
的基本内容:
#!/bin/bash
# 设置环境变量
export CHARLY_HOME=$(pwd)
# 启动项目
charly src/main.ch
3. 项目的配置文件介绍
项目的配置文件位于 config/default.yaml
。该文件包含了项目运行所需的各种配置参数。以下是 default.yaml
的基本内容:
server:
port: 8080
host: '0.0.0.0'
database:
host: 'localhost'
port: 3306
user: 'root'
password: 'password'
name: 'charly_db'
logging:
level: 'info'
file: 'logs/charly.log'
- server: 服务器配置,包括端口和主机地址。
- database: 数据库配置,包括主机、端口、用户名、密码和数据库名。
- logging: 日志配置,包括日志级别和日志文件路径。