Urungi 开源项目启动与配置教程

1. 项目目录结构及介绍

Urungi 是一个轻量级开源的业务智能和报告工具，支持多种数据库系统。以下是项目的目录结构及其简要介绍：

• bin/: 存放命令行界面的脚本。
• config/: 配置文件存放目录。
• doc/: 项目文档目录。
• language/: 存放项目所需的多语言翻译文件。
• migrations/: 数据库迁移脚本。
• public/: 存放静态文件，如CSS、JavaScript 和图片等。
• script/: 项目脚本文件。
• server/: 服务器端代码目录。
• src/: 前端代码目录。
• test/: 测试代码目录。
• views/: 视图文件目录。
• .dockerignore: Docker构建时需要排除的文件。
• .drone.jsonnet: Drone CI/CD 配置文件。
• .drone.yml: Drone CI/CD 配置文件。
• .editorconfig: 代码风格配置文件。
• .eslintignore: ESLint 忽略配置文件。
• .gitignore: Git 忽略配置文件。
• .htmlhintrc: HTMLHint 配置文件。
• .prettierignore: Prettier 忽略配置文件。
• .readthedocs.yaml: Read the Docs 配置文件。
• .stylelintignore: Stylelint 忽略配置文件。
• .stylelintrc.js: Stylelint 配置文件。
• CHANGELOG.md: 项目更新日志。
• Dockerfile: Docker构建文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• codecov.yml: CodeCov 配置文件。
• docker-compose.yml: Docker Compose 配置文件。
• docker-entrypoint.sh: Docker启动脚本。
• eslint.config.mjs: ESLint 配置文件。
• gulpfile.js: Gulp 配置文件。
• jest.config.js: Jest 测试配置文件。
• migrate-mongo-config.js: MongoDB 迁移配置文件。
• package-lock.json: npm 包锁定文件。
• package.json: npm 包配置文件。
• server.js: 服务器入口文件。
• vitest.workspace.js: Vitest 测试配置文件。

2. 项目的启动文件介绍

项目的启动文件是 server.js。这个文件负责初始化 Node.js 服务器，并设置路由和中间件。以下是启动文件的基本内容：

const express = require('express');
const app = express();

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

// 设置路由
app.use('/api', require('./routes/api'));

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

要启动项目，需要在项目根目录下运行以下命令：

node server.js

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下。以下是一些重要的配置文件及其作用：

• config.js: 核心配置文件，定义了项目的基本配置，如数据库连接信息、端口等。
• database.js: 数据库配置文件，定义了数据库连接的参数。
• express.js: Express 配置文件，定义了中间件和路由。

以下是一个简化的 config.js 配置文件示例：

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

确保正确配置数据库和其他相关设置，以便项目可以顺利启动和运行。