Fugu 开源项目使用教程

Fugu 开源项目使用教程

fuguFugu is simple, privacy-friendly, open-source and self-hostable product analytics. 🐡项目地址:https://gitcode.com/gh_mirrors/fu/fugu

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

fugu/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── config/
│   │   ├── default.json
│   │   ├── production.json
│   ├── utils/
│   ├── routes/
│   ├── models/
│   ├── controllers/
├── public/
│   ├── index.html
│   ├── css/
│   ├── js/
├── tests/

• README.md: 项目介绍文件。
• package.json: 项目依赖和脚本配置文件。
• src/: 源代码目录。
  • index.js: 项目启动文件。
  • config/: 配置文件目录。
    • default.json: 默认配置文件。
    • production.json: 生产环境配置文件。
  • utils/: 工具函数目录。
  • routes/: 路由定义目录。
  • models/: 数据模型目录。
  • controllers/: 控制器目录。
• public/: 静态资源目录。
  • index.html: 主页文件。
  • css/: CSS 文件目录。
  • js/: JavaScript 文件目录。
• tests/: 测试文件目录。

2. 项目的启动文件介绍

src/index.js 是项目的启动文件，负责初始化应用并启动服务器。以下是该文件的关键部分：

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

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

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

• 引入依赖: 引入 express 和其他必要的模块。
• 配置中间件: 使用静态文件中间件和路由中间件。
• 启动服务器: 监听指定端口并启动服务器。

3. 项目的配置文件介绍

src/config/ 目录下包含项目的配置文件，主要有两个：

• default.json: 默认配置文件，包含所有环境通用的配置。
• production.json: 生产环境配置文件，覆盖默认配置中的某些设置。

default.json

{
  "port": 3000,
  "db": {
    "host": "localhost",
    "name": "fugu_db"
  }
}

production.json

{
  "port": 8080,
  "db": {
    "host": "prod-db-server",
    "name": "fugu_prod_db"
  }
}

• port: 服务器监听的端口。
• db: 数据库配置，包括主机地址和数据库名称。

通过这些配置文件，可以灵活地管理不同环境下的应用设置。

fuguFugu is simple, privacy-friendly, open-source and self-hostable product analytics. 🐡项目地址:https://gitcode.com/gh_mirrors/fu/fugu