FS-Blog 开源项目教程

FS-Blog 开源项目教程

FS-Blog个人博客，Spring Boot 开山之作，采用 Spring Boot + MyBatis，前端 Bootstrap + LayUI，支持程序员非常青睐的轻量化的 Markdown 编辑器 Editor.md，支持标签分类检索项目地址:https://gitcode.com/gh_mirrors/fs/FS-Blog

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

FS-Blog 项目的目录结构如下：

FS-Blog/
├── app/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── services/
│   └── views/
├── config/
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── test/
├── .env
├── .gitignore
├── app.js
├── package.json
└── README.md

目录结构介绍

• app/: 包含应用程序的主要代码。
  • controllers/: 控制器文件，处理用户请求。
  • models/: 模型文件，定义数据结构和业务逻辑。
  • routes/: 路由文件，定义URL路径和处理逻辑。
  • services/: 服务文件，封装业务逻辑。
  • views/: 视图文件，定义用户界面。
• config/: 配置文件，包含应用程序的配置信息。
• public/: 静态文件目录，包含CSS、JavaScript和图片等静态资源。
• test/: 测试文件目录，包含单元测试和集成测试文件。
• .env: 环境变量文件，存储敏感信息和配置。
• .gitignore: Git忽略文件，指定不需要版本控制的文件和目录。
• app.js: 应用程序的入口文件。
• package.json: 项目依赖和脚本配置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

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

app.js 主要内容

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

// 引入路由
const indexRouter = require('./app/routes/index');

// 设置中间件
app.use(express.json());
app.use(express.urlencoded({ extended: false }));
app.use(express.static(path.join(__dirname, 'public')));

// 使用路由
app.use('/', indexRouter);

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

启动文件功能

• 引入 Express 框架并初始化应用程序。
• 设置中间件，处理请求和响应。
• 引入并使用路由文件，定义URL路径和处理逻辑。
• 启动服务器，监听指定端口。

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，以及 .env 文件。

config/ 目录

config/ 目录包含应用程序的配置文件，例如数据库配置、日志配置等。

config/
├── db.js
├── logger.js
└── settings.js

.env 文件

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

PORT=3000
DB_HOST=localhost
DB_USER=root
DB_PASSWORD=123456
DB_NAME=fs_blog

配置文件功能

• db.js: 数据库配置文件，定义数据库连接信息。
• logger.js: 日志配置文件，定义日志记录方式和级别。
• settings.js: 应用程序设置文件，定义全局配置。
• .env: 环境变量文件，存储敏感信息和配置。

通过这些配置文件，可以灵活地调整应用程序的行为和设置，确保应用程序在不同环境下的稳定运行。

FS-Blog个人博客，Spring Boot 开山之作，采用 Spring Boot + MyBatis，前端 Bootstrap + LayUI，支持程序员非常青睐的轻量化的 Markdown 编辑器 Editor.md，支持标签分类检索项目地址:https://gitcode.com/gh_mirrors/fs/FS-Blog