首页
/ 开源项目教程:ifwenvlook/blog

开源项目教程:ifwenvlook/blog

2024-08-19 14:49:45作者:柏廷章Berta

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

blog/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── views/
│   └── routes.js
├── config/
│   ├── db.js
│   ├── auth.js
│   └── config.js
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── .env
├── .gitignore
├── package.json
└── server.js

目录结构介绍

  • app/: 包含应用程序的主要逻辑,分为控制器、模型和视图。
    • controllers/: 处理用户请求和业务逻辑。
    • models/: 定义数据模型和数据库交互。
    • views/: 包含视图模板文件。
    • routes.js: 定义应用程序的路由。
  • config/: 包含配置文件,如数据库配置、认证配置等。
    • db.js: 数据库连接配置。
    • auth.js: 认证相关配置。
    • config.js: 通用配置文件。
  • public/: 存放静态文件,如CSS、JavaScript和图片。
    • css/: 样式文件。
    • js/: 脚本文件。
    • images/: 图片文件。
  • .env: 环境变量配置文件。
  • .gitignore: 指定不需要跟踪的文件和目录。
  • package.json: 项目依赖和脚本配置。
  • server.js: 应用程序的入口文件。

2. 项目的启动文件介绍

server.js

server.js 是项目的入口文件,负责启动服务器和初始化应用程序。以下是 server.js 的主要内容:

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

require('./config/db'); // 连接数据库
require('./app/routes')(app); // 加载路由

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

启动文件介绍

  • 引入依赖: 使用 require 引入 express 和其他必要的模块。
  • 创建应用实例: 使用 express() 创建应用实例 app
  • 配置端口: 从环境变量中获取端口,默认为 3000。
  • 连接数据库: 调用 config/db.js 连接数据库。
  • 加载路由: 调用 app/routes.js 加载应用程序的路由。
  • 启动服务器: 使用 app.listen 启动服务器并监听指定端口。

3. 项目的配置文件介绍

config/db.js

db.js 负责数据库的连接配置。以下是 db.js 的主要内容:

const mongoose = require('mongoose');

mongoose.connect(process.env.MONGODB_URI || 'mongodb://localhost/blog', {
  useNewUrlParser: true,
  useUnifiedTopology: true
});

mongoose.connection.on('connected', () => {
  console.log('Mongoose is connected');
});

mongoose.connection.on('error', (err) => {
  console.log('Mongoose connection error: ' + err);
});

config/auth.js

auth.js 负责认证相关的配置。以下是 auth.js 的主要内容:

module.exports = {
  secret: process.env.SECRET || 'your_secret_key'
};

config/config.js

config.js 是通用配置文件。以下是 config.js 的主要内容:

module.exports = {
  appName: 'Blog',
  version: '1.0.0'
};

配置文件介绍

  • db.js: 连接 MongoDB 数据库,使用环境变量 MONGODB_URI 或默认连接本地数据库。
  • auth.js: 定义认证密钥,使用环境变量 SECRET 或默认密钥。
  • **config.js
登录后查看全文