开源项目 hiwara 使用教程

开源项目 hiwara 使用教程

hiwaraiwara for uni-app, Apply Android and iOS 项目地址:https://gitcode.com/gh_mirrors/hi/hiwara

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

hiwara/
├── README.md
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── routes.js
├── config/
│   ├── default.json
│   ├── production.json
│   └── test.json
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── server.js
└── package.json

• README.md: 项目说明文件。
• app/: 应用的主要代码目录。
  • controllers/: 存放控制器文件。
  • models/: 存放数据模型文件。
  • views/: 存放视图文件。
  • routes.js: 路由配置文件。
• config/: 配置文件目录。
  • default.json: 默认配置文件。
  • production.json: 生产环境配置文件。
  • test.json: 测试环境配置文件。
• public/: 静态资源目录。
  • css/: 样式文件。
  • js/: 脚本文件。
  • images/: 图片文件。
• server.js: 项目启动文件。
• package.json: 项目依赖和脚本配置文件。

2. 项目的启动文件介绍

server.js 是项目的启动文件，负责初始化服务器和加载必要的模块。以下是 server.js 的主要内容：

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

app.use(express.static('public'));
app.use('/', require('./app/routes'));

const PORT = process.env.PORT || config.port;
app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

• 引入 express 模块: 用于创建服务器。
• 加载配置文件: 从 config/default.json 中读取配置。
• 设置静态资源目录: 将 public 目录设置为静态资源目录。
• 设置路由: 加载 app/routes.js 中的路由配置。
• 启动服务器: 监听指定端口，默认端口从配置文件中读取。

3. 项目的配置文件介绍

config/ 目录下包含三个配置文件：

• default.json: 默认配置文件，包含基本配置项。
• production.json: 生产环境配置文件，覆盖默认配置中的某些项。
• test.json: 测试环境配置文件，覆盖默认配置中的某些项。

以下是 default.json 的一个示例：

{
  "port": 3000,
  "database": {
    "host": "localhost",
    "user": "root",
    "password": "",
    "name": "hiwara"
  }
}

• port: 服务器监听的端口。
• database: 数据库连接配置。
  • host: 数据库主机地址。
  • user: 数据库用户名。
  • password: 数据库密码。
  • name: 数据库名称。

在不同的环境中，可以通过加载不同的配置文件来覆盖默认配置，以适应不同的部署需求。

hiwaraiwara for uni-app, Apply Android and iOS 项目地址:https://gitcode.com/gh_mirrors/hi/hiwara