AOMaker 项目启动与配置教程

1. 项目目录结构及介绍

AOMaker 项目的目录结构如下：

aomaker/
├── .gitignore             # 忽略文件列表
├── Dockerfile             # Docker 容器配置文件
├── README.md              # 项目说明文件
├── docker-compose.yml     # Docker 编排配置文件
├── config/                # 配置文件目录
│   └── app.json            # 应用配置文件
├── src/                   # 源代码目录
│   ├── main/              # 主程序目录
│   │   └── index.js        # 主程序入口文件
│   ├── models/            # 数据模型目录
│   ├── routes/            # 路由目录
│   ├── views/             # 视图目录
│   └── utils/             # 工具类目录
└── test/                  # 测试目录

• .gitignore: 指定在版本控制中需要忽略的文件和目录。
• Dockerfile: 定义了如何构建项目镜像。
• README.md: 包含项目的基本信息、安装步骤和使用说明。
• docker-compose.yml: 定义了服务、网络和卷的配置，用于多容器部署。
• config/: 包含项目配置文件。
  • app.json: 包含项目的基本配置信息。
• src/: 包含项目的源代码。
  • main/: 包含项目的主程序。
    • index.js: 项目的主入口文件。
  • models/: 包含数据模型相关的文件。
  • routes/: 包含定义路由的文件。
  • views/: 包含视图模板文件。
  • utils/: 包含项目的工具类和函数。
• test/: 包含项目的测试代码。

2. 项目的启动文件介绍

项目的启动文件位于 src/main/index.js。以下是启动文件的基本内容：

// 引入必要的模块和配置
const app = require('../app');
const port = process.env.PORT || 3000;

// 启动服务器
app.listen(port, () => {
  console.log(`AOMaker 应用正在监听端口 ${port}`);
});

这段代码引入了应用的主体模块 app，并设置了一个默认的端口 3000，然后调用 listen 方法启动服务器。

3. 项目的配置文件介绍

项目的配置文件位于 config/app.json。以下是配置文件的基本内容：

{
  "port": 3000,
  "host": "localhost",
  "db": {
    "username": "root",
    "password": "password",
    "database": "aomaker",
    "host": "localhost",
    "port": 3306
  }
}

配置文件定义了应用的运行端口 port，服务器地址 host，以及数据库的连接信息，包括用户名 username、密码 password、数据库名 database、数据库地址 host 和端口号 port。这些配置信息可以在部署时根据实际环境进行修改。