Tanam 项目使用教程

Tanam 项目使用教程

tanamPlug-n-play CMS for websites on Firebase项目地址:https://gitcode.com/gh_mirrors/ta/tanam

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

tanam/
├── config/
│   ├── default.json
│   └── production.json
├── controllers/
│   ├── auth.js
│   ├── content.js
│   └── user.js
├── models/
│   ├── content.js
│   └── user.js
├── routes/
│   ├── auth.js
│   ├── content.js
│   └── user.js
├── services/
│   ├── auth.js
│   ├── content.js
│   └── user.js
├── views/
│   ├── index.ejs
│   └── layout.ejs
├── app.js
├── package.json
└── README.md

目录结构说明

• config/: 存放项目的配置文件，包括默认配置和生产环境配置。
• controllers/: 存放控制器文件，处理业务逻辑。
• models/: 存放数据模型文件，定义数据结构。
• routes/: 存放路由文件，定义API接口。
• services/: 存放服务文件，处理复杂业务逻辑。
• views/: 存放视图文件，使用EJS模板引擎。
• app.js: 项目的启动文件。
• package.json: 项目的依赖管理文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

app.js

app.js 是项目的启动文件，负责初始化Express应用并启动服务器。以下是 app.js 的主要内容：

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

// 中间件配置
app.use(express.json());
app.use(express.urlencoded({ extended: true }));

// 路由配置
app.use('/api/auth', require('./routes/auth'));
app.use('/api/content', require('./routes/content'));
app.use('/api/user', require('./routes/user'));

// 视图引擎配置
app.set('view engine', 'ejs');
app.set('views', './views');

// 启动服务器
const PORT = process.env.PORT || config.port;
app.listen(PORT, () => {
  console.log(`Server is running on port ${PORT}`);
});

启动文件说明

• Express初始化: 使用 express() 初始化应用。
• 中间件配置: 配置JSON解析和URL编码解析中间件。
• 路由配置: 加载各个模块的路由文件。
• 视图引擎配置: 配置EJS模板引擎。
• 服务器启动: 根据配置文件中的端口启动服务器。

3. 项目的配置文件介绍

config/default.json

default.json 是项目的默认配置文件，包含应用的基本配置信息。以下是 default.json 的内容示例：

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "port": 27017,
    "name": "tanam"
  },
  "jwt": {
    "secret": "your_jwt_secret"
  }
}

配置文件说明

• port: 应用的监听端口。
• database: 数据库的连接配置，包括主机、端口和数据库名称。
• jwt: JWT（JSON Web Token）的密钥配置。

config/production.json

production.json 是生产环境的配置文件，通常会覆盖 default.json 中的某些配置。以下是 production.json 的内容示例：

{
  "port": 8080,
  "database": {
    "host": "production_db_host",
    "port": 27017,
    "name": "tanam_production"
  },
  "jwt": {
    "secret": "production_jwt_secret"
  }
}

生产环境配置说明

• port: 生产环境的监听端口。
• database: 生产环境的数据库连接配置。
• jwt: 生产环境的JWT密钥配置。

通过以上配置文件，可以根据不同的环境（开发、生产等）加载不同的配置，确保应用在不同环境下的正常运行。

tanamPlug-n-play CMS for websites on Firebase项目地址:https://gitcode.com/gh_mirrors/ta/tanam