Jandi 开源项目教程

Jandi 开源项目教程

Jandi🌱 Menubar app to track your Github contributions.项目地址:https://gitcode.com/gh_mirrors/ja/Jandi

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

Jandi 项目的目录结构如下：

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

目录结构介绍

• app/: 包含应用程序的主要逻辑，包括控制器、模型和视图。
  • controllers/: 处理用户输入和响应。
  • models/: 定义数据模型和数据库交互。
  • views/: 包含视图模板。
  • routes.js: 定义应用程序的路由。
• config/: 包含配置文件，用于不同环境下的配置。
  • default.json: 默认配置文件。
  • production.json: 生产环境配置文件。
  • test.json: 测试环境配置文件。
• public/: 包含静态文件，如CSS、JavaScript和图像。
  • css/: 样式文件。
  • js/: 客户端脚本。
  • images/: 图像文件。
• server.js: 应用程序的入口文件。
• package.json: 包含项目的依赖和脚本。

2. 项目的启动文件介绍

server.js 是 Jandi 项目的启动文件。它负责启动服务器并加载应用程序的其他部分。以下是 server.js 的主要内容：

const express = require('express');
const app = express();
const port = process.env.PORT || 3000;

app.use(express.static('public'));
app.use(express.json());
app.use(express.urlencoded({ extended: true }));

require('./app/routes')(app);

app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});

启动文件介绍

• 引入 express 模块并创建一个应用实例。
• 设置静态文件目录为 public。
• 解析 JSON 和 URL 编码的请求体。
• 加载路由配置。
• 监听指定端口并启动服务器。

3. 项目的配置文件介绍

Jandi 项目的配置文件位于 config/ 目录下，主要包括 default.json、production.json 和 test.json。

配置文件介绍

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

示例 default.json

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

示例 production.json

{
  "port": 8080,
  "database": {
    "host": "production-db-host",
    "user": "prod_user",
    "password": "prod_password",
    "name": "jandi_prod"
  }
}

示例 test.json

{
  "port": 3001,
  "database": {
    "host": "test-db-host",
    "user": "test_user",
    "password": "test_password",
    "name": "jandi_test"
  }
}

配置文件使用

配置文件通过 config 模块加载，可以在应用程序中通过以下方式访问配置：

const config = require('config');

const port = config.get('port');
const dbConfig = config.get('database');

这样可以根据不同的环境加载相应的配置。

Jandi🌱 Menubar app to track your Github contributions.项目地址:https://gitcode.com/gh_mirrors/ja/Jandi