开源项目 `wenku` 使用教程

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

wenku/
├── README.md
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── routes.js
├── config/
│   ├── database.js
│   └── environment.js
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── server.js
└── package.json

目录结构介绍

• README.md: 项目的基本介绍文件。
• app/: 包含应用程序的主要代码。
  • controllers/: 存放控制器文件，处理业务逻辑。
  • models/: 存放数据模型文件，定义数据结构和操作。
  • views/: 存放视图文件，负责前端展示。
  • routes.js: 定义应用程序的路由。
• config/: 存放配置文件。
  • database.js: 数据库配置文件。
  • environment.js: 环境配置文件。
• public/: 存放静态资源文件。
  • css/: 存放CSS样式文件。
  • js/: 存放JavaScript脚本文件。
  • images/: 存放图片资源。
• server.js: 项目的启动文件。
• package.json: 项目的依赖管理文件。

2. 项目的启动文件介绍

server.js

server.js 是项目的启动文件，负责启动应用程序。以下是文件的基本结构：

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

// 配置中间件
app.use(express.static('public'));

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

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

启动文件介绍

• 引入依赖: 引入了 express 框架和配置文件 environment.js。
• 配置中间件: 使用 express.static 中间件加载静态资源。
• 加载路由: 通过 require('./app/routes')(app) 加载应用程序的路由。
• 启动服务器: 使用 app.listen 方法启动服务器，监听配置文件中定义的端口。

3. 项目的配置文件介绍

config/environment.js

environment.js 文件用于配置应用程序的环境变量，如端口号、数据库连接等。以下是文件的基本结构：

module.exports = {
  port: process.env.PORT || 3000,
  database: {
    host: 'localhost',
    user: 'root',
    password: 'password',
    dbName: 'wenku'
  }
};

配置文件介绍

• 端口号: port 配置了应用程序的监听端口，默认值为 3000。
• 数据库配置: database 对象包含了数据库的连接信息，包括主机地址、用户名、密码和数据库名称。

config/database.js

database.js 文件用于配置数据库连接。以下是文件的基本结构：

const mysql = require('mysql');
const config = require('./environment');

const connection = mysql.createConnection({
  host: config.database.host,
  user: config.database.user,
  password: config.database.password,
  database: config.database.dbName
});

connection.connect((err) => {
  if (err) throw err;
  console.log('Database connected!');
});

module.exports = connection;

数据库配置文件介绍

• 引入依赖: 引入了 mysql 模块和 environment.js 配置文件。
• 创建连接: 使用 mysql.createConnection 方法创建数据库连接，并传入配置文件中的数据库信息。
• 连接数据库: 使用 connection.connect 方法连接数据库，并在连接成功后输出提示信息。
• 导出连接: 将数据库连接对象导出，供其他模块使用。

---

以上是开源项目 wenku 的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你快速上手该项目。