Tiny Humans 开源项目教程

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

tinyhumans/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── models/
│   ├── routes/
│   ├── controllers/
│   ├── utils/
├── public/
│   ├── index.html
│   ├── css/
│   ├── js/
│   ├── images/

• README.md: 项目说明文件。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • models/: 数据模型目录。
  • routes/: 路由配置目录。
  • controllers/: 控制器目录。
  • utils/: 工具函数目录。
• public/: 静态资源目录。
  • index.html: 主页文件。
  • css/: CSS 文件目录。
  • js/: JavaScript 文件目录。
  • images/: 图片文件目录。

2. 项目的启动文件介绍

src/index.js 是项目的入口文件，负责启动应用。以下是该文件的主要内容：

const express = require('express');
const app = express();
const config = require('./config');

app.use(express.static('public'));

app.get('/', (req, res) => {
  res.sendFile(__dirname + '/public/index.html');
});

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

• 引入 express 模块并创建应用实例。
• 设置静态文件目录为 public。
• 定义根路由，返回 public/index.html 文件。
• 监听端口，默认端口为 3000。

3. 项目的配置文件介绍

src/config/ 目录下包含项目的配置文件：

• default.json: 默认配置文件，包含开发环境的配置。
• production.json: 生产环境配置文件，包含生产环境的配置。

以下是 default.json 的示例内容：

{
  "port": 3000,
  "db": {
    "host": "localhost",
    "user": "root",
    "password": "",
    "database": "tinyhumans"
  }
}

• port: 应用监听的端口。
• db: 数据库配置，包括主机、用户名、密码和数据库名。

production.json 的内容与 default.json 类似，但包含生产环境的特定配置，例如数据库连接信息等。