CandyBar 开源项目使用教程

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

CandyBar 项目的目录结构如下：

candybar/
├── assets/
│   ├── css/
│   ├── images/
│   └── js/
├── config/
│   └── config.json
├── src/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── main.js
├── tests/
│   ├── unit/
│   └── integration/
├── .gitignore
├── package.json
├── README.md
└── server.js

目录结构介绍

• assets/: 存放项目的静态资源文件，包括 CSS、图片和 JavaScript 文件。

  • css/: 存放项目的样式表文件。
  • images/: 存放项目的图片资源。
  • js/: 存放项目的 JavaScript 文件。

• config/: 存放项目的配置文件。

  • config.json: 项目的配置文件，包含数据库连接、端口设置等信息。

• src/: 存放项目的源代码文件。

  • controllers/: 存放控制器文件，处理业务逻辑。
  • models/: 存放模型文件，定义数据结构和数据库操作。
  • views/: 存放视图文件，定义用户界面。
  • main.js: 项目的入口文件，初始化应用。

• tests/: 存放项目的测试文件。

  • unit/: 存放单元测试文件。
  • integration/: 存放集成测试文件。

• .gitignore: Git 忽略文件，指定不需要版本控制的文件和目录。

• package.json: 项目的依赖管理文件，包含项目的依赖包和脚本命令。

• README.md: 项目的说明文档，介绍项目的基本信息和使用方法。

• server.js: 项目的启动文件，启动服务器并监听端口。

2. 项目的启动文件介绍

项目的启动文件是 server.js，该文件负责启动服务器并监听指定端口。以下是 server.js 的主要内容：

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

// 设置静态资源目录
app.use(express.static('assets'));

// 加载路由
require('./src/main')(app);

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

启动文件介绍

• 引入依赖: 首先引入了 express 框架和项目的配置文件 config.json。
• 设置静态资源目录: 使用 express.static 方法设置静态资源目录为 assets/。
• 加载路由: 通过 require('./src/main') 加载项目的路由配置。
• 启动服务器: 从配置文件中获取端口号，启动服务器并监听该端口。

3. 项目的配置文件介绍

项目的配置文件是 config/config.json，该文件包含了项目的各种配置信息，如数据库连接、端口设置等。以下是 config.json 的内容示例：

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "user": "root",
    "password": "password",
    "name": "candybar"
  },
  "api": {
    "key": "your-api-key"
  }
}

配置文件介绍

• port: 指定服务器监听的端口号，默认为 3000。
• database: 数据库连接配置。
  • host: 数据库主机地址，默认为 localhost。
  • user: 数据库用户名。
  • password: 数据库密码。
  • name: 数据库名称。
• api: API 密钥配置。
  • key: API 密钥，用于访问外部 API。

通过修改 config.json 文件，可以轻松调整项目的配置，以适应不同的开发和生产环境。