KEMAI 项目启动与配置教程

1. 项目目录结构及介绍

KEMAI 项目的目录结构如下：

kemai/
├── .gitignore
├── .vscode/
│   └── settings.json
├── Dockerfile
├── README.md
├── composer.json
├── composer.lock
├── config/
│   ├── config.php
│   ├── database.php
│   └── router.php
├── public/
│   ├── index.php
│   └── static/
│       ├── css/
│       ├── img/
│       └── js/
├── src/
│   ├── Controller/
│   │   └── IndexController.php
│   ├── Model/
│   │   └── ExampleModel.php
│   └── View/
│       └── index.php
└── tests/
    └── ...

• .gitignore：Git 忽略文件列表，用于指定在 Git 仓库中应该被忽略的文件。
• .vscode/：Visual Studio Code 的配置文件目录。
• Dockerfile：用于构建 Docker 容器的配置文件。
• README.md：项目的说明文件，通常包含项目的介绍、安装和配置指南。
• composer.json：PHP 项目的依赖管理文件。
• composer.lock：锁定项目的依赖版本。
• config/：配置文件目录，包含项目运行所需的各种配置。
• public/：公开目录，包含可以被用户访问的文件。
  • index.php：通常是用户访问项目的入口文件。
  • static/：静态资源目录，包含 CSS、图片和 JavaScript 文件。
• src/：源代码目录，包含项目的核心代码。
  • Controller/：控制器目录，处理用户请求。
  • Model/：模型目录，通常与数据库交互。
  • View/：视图目录，用于显示用户界面。
• tests/：测试代码目录。

2. 项目的启动文件介绍

项目的启动文件是 public/index.php，这是用户访问项目时的入口点。以下是一个简化的示例：

<?php
// 引入自动加载文件
require __DIR__ . '/../vendor/autoload.php';

// 引入配置文件
$config = require __DIR__ . '/../config/config.php';

// 创建应用实例并运行
$app = new App($config);
$app->run();

在这个文件中，通常会完成以下步骤：

• 引入自动加载文件，以便自动加载项目依赖。
• 引入配置文件，配置文件通常包含数据库连接信息、路由设置等。
• 创建应用实例，并调用运行方法启动应用。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，通常包括以下文件：

• config.php：主配置文件，定义了一些全局设置，如数据库连接信息、应用模式等。
• database.php：数据库配置文件，包含了数据库连接的详细信息。
• router.php：路由配置文件，定义了 URL 路径与控制器方法的映射。

config.php 示例内容：

<?php
return [
    'database' => include 'database.php',
    'router' => include 'router.php',
    // 其他配置...
];

database.php 示例内容：

<?php
return [
    'host' => '127.0.0.1',
    'username' => 'root',
    'password' => 'password',
    'database' => 'kemai',
    // 其他数据库配置...
];

router.php 示例内容：

<?php
return [
    '/' => 'IndexController@index',
    // 其他路由映射...
];

配置文件通常用于集中管理项目运行所需的各种参数，使得项目更容易维护和部署。