ONEGRAM 开源项目教程-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00508/article/details/141771621

ONEGRAM 开源项目教程

onegramThis repository is no longer maintained.项目地址:https://gitcode.com/gh_mirrors/on/onegram

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

ONEGRAM 项目的目录结构如下：

onegram/
├── docs/
├── src/
│   ├── config/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── services/
│   └── index.js
├── tests/
├── .env
├── .gitignore
├── package.json
└── README.md

目录介绍：

docs/: 存放项目文档。
src/: 项目的源代码目录。
- config/: 配置文件目录。
- controllers/: 控制器文件目录。
- models/: 数据模型文件目录。
- routes/: 路由文件目录。
- services/: 服务文件目录。
- index.js: 项目的入口文件。
tests/: 测试文件目录。
.env: 环境变量配置文件。
.gitignore: Git 忽略文件配置。
package.json: 项目的依赖和脚本配置文件。
README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 src/index.js。这个文件是整个应用的入口点，负责初始化应用并启动服务器。

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

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(port, () => {
  console.log(`App listening at http://localhost:${port}`);
});

启动文件功能：

引入 express 模块。
创建一个 Express 应用实例。
设置端口，默认是 3000。
定义一个简单的路由，返回 "Hello World!"。
启动服务器并监听指定端口。

3. 项目的配置文件介绍

项目的配置文件主要有两个：.env 和 src/config/ 目录下的配置文件。

`.env` 文件

.env 文件用于存储环境变量，例如数据库连接字符串、端口号等。

PORT=3000
DB_URI=mongodb://localhost:27017/onegram

`src/config/` 目录

src/config/ 目录下通常包含多个配置文件，例如数据库配置、日志配置等。

// src/config/db.js
const mongoose = require('mongoose');

const connectDB = async () => {
  try {
    await mongoose.connect(process.env.DB_URI, {
      useNewUrlParser: true,
      useUnifiedTopology: true,
    });
    console.log('MongoDB connected');
  } catch (error) {
    console.error(error.message);
    process.exit(1);
  }
};

module.exports = connectDB;