开源项目 tin 使用教程

开源项目 tin 使用教程

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

tin/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── routes/
│   │   ├── index.js
│   ├── models/
│   │   ├── User.js
│   ├── controllers/
│   │   ├── userController.js
│   ├── utils/
│   │   ├── helper.js
├── public/
│   ├── index.html
│   ├── styles.css

• README.md: 项目说明文档。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目入口文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • routes/: 路由配置目录。
    • index.js: 路由入口文件。
  • models/: 数据模型目录。
    • User.js: 用户模型文件。
  • controllers/: 控制器目录。
    • userController.js: 用户控制器文件。
  • utils/: 工具函数目录。
    • helper.js: 辅助函数文件。
• public/: 静态资源目录。
  • index.html: 主页HTML文件。
  • styles.css: 样式文件。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。该文件主要负责初始化应用，包括加载配置、设置路由、启动服务器等。以下是 index.js 的主要内容：

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

const app = express();
const port = config.get('port');

app.use('/', routes);

app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

• 引入 express 框架。
• 加载配置文件。
• 设置路由。
• 启动服务器并监听指定端口。

3. 项目的配置文件介绍

项目的配置文件位于 src/config/ 目录下，主要包括 default.json 和 production.json。

default.json

{
  "port": 3000,
  "db": {
    "host": "localhost",
    "name": "tin_db"
  }
}

• port: 服务器监听的端口。
• db: 数据库配置，包括主机地址和数据库名称。

production.json

{
  "port": 8080,
  "db": {
    "host": "production_host",
    "name": "tin_production_db"
  }
}

• port: 生产环境服务器监听的端口。
• db: 生产环境数据库配置，包括主机地址和数据库名称。

配置文件通过 config 模块加载，可以根据环境变量选择不同的配置文件。