mdash 项目启动与配置教程

1. 项目目录结构及介绍

mdash 项目是一个开源项目，其目录结构如下所示：

mdash/
├── app/                      # 应用程序主目录
│   ├── controllers/          # 控制器目录
│   ├── models/               # 模型目录
│   ├── services/             # 服务目录
│   ├── views/                # 视图目录
│   └── main.go               # 应用程序入口文件
├── config/                   # 配置文件目录
│   └── config.yaml           # 配置文件
├── docs/                     # 文档目录
├── scripts/                  # 脚本目录
├── static/                   # 静态资源目录
│   ├── css/                  # CSS 文件
│   ├── images/               # 图片文件
│   └── js/                   # JavaScript 文件
├── templates/                # 模板文件目录
├── test/                     # 测试目录
└── .gitignore                # Git 忽略文件

目录说明：

• app/: 项目的主要应用程序目录，包含了控制器、模型、服务和视图等模块。
• config/: 配置文件目录，包含了项目的配置信息。
• docs/: 文档目录，存放项目相关的文档资料。
• scripts/: 脚本目录，存放项目相关的脚本文件。
• static/: 静态资源目录，包含了 CSS、图片和 JavaScript 文件。
• templates/: 模板文件目录，存放 HTML 模板文件。
• test/: 测试目录，存放单元测试和集成测试代码。
• .gitignore: 指定 Git 忽略的文件和目录。

2. 项目的启动文件介绍

项目的启动文件位于 app/main.go。以下是 main.go 文件的主要内容：

package main

import (
    "log"
    "net/http"
    "github.com/emuravjev/mdash/app"
)

func main() {
    // 初始化应用程序
    app.Init()

    // 设置 HTTP 服务器路由
    http.HandleFunc("/", app.HomeHandler)
    // ... 可能还有其他路由设置

    // 启动 HTTP 服务器
    log.Fatal(http.ListenAndServe(":8080", nil))
}

在 main.go 文件中，首先导入了必要的包，然后在 main 函数中初始化应用程序，设置 HTTP 服务器路由，并启动监听在 8080 端口的 HTTP 服务器。

3. 项目的配置文件介绍

项目的配置文件位于 config/config.yaml。以下是 config.yaml 文件的一个示例：

server:
  port: 8080
  host: localhost

database:
  driver: postgres
  host: localhost
  port: 5432
  user: user
  password: pass
  database: mdash_db

配置文件说明：

• server: 服务器配置，包括端口和主机名。
• database: 数据库配置，包括数据库驱动、主机、端口、用户名、密码和数据库名称。

在项目中，通常会有一个配置管理器来读取这个 YAML 文件，并根据其中的配置信息来设置应用程序的运行参数。