Medici 开源项目使用教程

Medici 开源项目使用教程

mediciDouble-entry accounting system for nodejs + mongoose项目地址:https://gitcode.com/gh_mirrors/me/medici

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

Medici 项目的目录结构如下：

medici/
├── config/
│   ├── default.json
│   ├── development.json
│   ├── production.json
│   └── test.json
├── src/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── services/
│   └── index.js
├── tests/
├── .env
├── .gitignore
├── package.json
└── README.md

目录结构介绍

• config/: 包含项目的配置文件，如默认配置、开发环境配置、生产环境配置和测试环境配置。
• src/: 项目的源代码目录，包含控制器、模型、路由和服务等。
  • controllers/: 处理请求逻辑的控制器文件。
  • models/: 数据库模型文件。
  • routes/: 定义API路由的文件。
  • services/: 业务逻辑服务文件。
  • index.js: 项目的入口文件。
• tests/: 包含项目的测试文件。
• .env: 环境变量配置文件。
• .gitignore: Git忽略文件配置。
• package.json: 项目的依赖和脚本配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。该文件主要负责以下任务：

• 加载配置文件。
• 初始化数据库连接。
• 设置路由。
• 启动HTTP服务器。

以下是 src/index.js 的简化示例代码：

const express = require('express');
const config = require('config');
const mongoose = require('mongoose');
const routes = require('./routes');

const app = express();

// 加载配置
const dbConfig = config.get('dbConfig');

// 连接数据库
mongoose.connect(dbConfig.uri, dbConfig.options)
  .then(() => console.log('MongoDB connected'))
  .catch(err => console.error('MongoDB connection error:', err));

// 设置中间件
app.use(express.json());

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

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

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，主要包括以下文件：

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

配置文件示例

default.json:

{
  "dbConfig": {
    "uri": "mongodb://localhost:27017/medici",
    "options": {
      "useNewUrlParser": true,
      "useUnifiedTopology": true
    }
  },
  "server": {
    "port": 3000
  }
}

development.json:

{
  "dbConfig": {
    "uri": "mongodb://localhost:27017/medici_dev"
  }
}

production.json:

{
  "dbConfig": {
    "uri": "mongodb://prod-db-server:27017/medici_prod"
  }
}

test.json:

{
  "dbConfig": {
    "uri": "mongodb://localhost:27017/medici_test"
  }
}

通过这些配置文件，可以灵活地管理不同环境下的数据库连接和其他设置。

mediciDouble-entry accounting system for nodejs + mongoose项目地址:https://gitcode.com/gh_mirrors/me/medici