CromwellCMS 项目教程

1. 项目目录结构及介绍

CromwellCMS 项目的目录结构如下：

Cromwell/
├── apps/
│   ├── admin/
│   ├── site/
│   └── ...
├── core/
│   ├── api/
│   ├── config/
│   ├── models/
│   └── ...
├── plugins/
│   ├── example-plugin/
│   └── ...
├── public/
│   ├── assets/
│   └── ...
├── scripts/
├── server/
│   ├── controllers/
│   ├── routes/
│   └── ...
├── views/
│   ├── layouts/
│   └── ...
├── .env
├── .gitignore
├── package.json
└── README.md

目录结构介绍

• apps/: 包含项目的应用程序，如管理后台 (admin) 和前端站点 (site)。
• core/: 包含项目的核心代码，如 API 接口 (api)、配置文件 (config) 和数据模型 (models)。
• plugins/: 包含项目的插件，每个插件都有自己的目录。
• public/: 包含项目的静态资源，如图片、CSS 和 JavaScript 文件。
• scripts/: 包含项目的脚本文件，如构建脚本和自动化任务。
• server/: 包含服务器的代码，如控制器 (controllers) 和路由 (routes)。
• views/: 包含项目的视图文件，如布局 (layouts) 和页面模板。
• .env: 项目的配置文件，包含环境变量。
• .gitignore: Git 忽略文件列表。
• package.json: 项目的依赖管理文件。
• README.md: 项目的说明文档。

2. 项目启动文件介绍

CromwellCMS 项目的启动文件通常位于 server/ 目录下。主要的启动文件可能是 server/index.js 或 server/app.js。

启动文件示例

// server/index.js
const express = require('express');
const app = express();
const port = process.env.PORT || 3000;

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

app.get('/', (req, res) => {
  res.send('Hello World!');
});

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

启动文件介绍

• express: 使用 Express 框架来创建服务器。
• app.use(express.static('public')): 设置静态文件目录。
• app.get('/', ...): 定义根路由的处理函数。
• app.listen(port, ...): 启动服务器并监听指定端口。

3. 项目配置文件介绍

CromwellCMS 项目的配置文件通常是 .env 文件，用于存储环境变量。

配置文件示例

# .env
PORT=3000
DB_HOST=localhost
DB_USER=root
DB_PASSWORD=secret
DB_NAME=cromwell

配置文件介绍

• PORT: 服务器监听的端口。
• DB_HOST: 数据库主机地址。
• DB_USER: 数据库用户名。
• DB_PASSWORD: 数据库密码。
• DB_NAME: 数据库名称。

这些配置项可以在启动文件中通过 process.env 访问。

const port = process.env.PORT || 3000;
const dbHost = process.env.DB_HOST || 'localhost';

通过这种方式，可以方便地管理和切换不同环境下的配置。