Starguard 项目启动与配置教程

1. 项目目录结构及介绍

Starguard 项目的目录结构如下所示：

Starguard/
│
├── .gitignore       # 忽略文件列表
├── .vscode/         # VSCode 编辑器配置文件夹
│   └── settings.json # VSCode 配置文件
├── config/          # 配置文件目录
│   ├── app.json     # 应用配置文件
│   └── database.json # 数据库配置文件
│
├── controllers/     # 控制器目录
│   └── index.js      # 默认控制器
│
├── models/          # 数据模型目录
│   └── user.js       # 用户模型
│
├── public/          # 公共静态资源目录
│   ├── css/
│   ├── img/
│   ├── js/
│   └── lib/
│
├── routes/          # 路由目录
│   └── index.js      # 默认路由
│
├── views/           # 视图目录
│   └── index.ejs     # 默认视图
│
└── app.js           # 项目入口文件

• .gitignore：指定在版本控制中忽略的文件。
• .vscode/settings.json：Visual Studio Code 的配置文件。
• config/：存放项目的配置文件。
  • app.json：应用级配置文件。
  • database.json：数据库配置文件。
• controllers/：控制器目录，用于处理请求。
  • index.js：默认控制器。
• models/：数据模型目录，用于定义数据结构。
  • user.js：用户模型。
• public/：公共静态资源目录，如CSS、图片、JavaScript等。
• routes/：路由目录，用于定义URL路径与控制器的映射。
  • index.js：默认路由。
• views/：视图目录，存放HTML模板文件。
  • index.ejs：默认视图。
• app.js：项目入口文件，用于启动服务器。

2. 项目的启动文件介绍

项目的启动文件是 app.js。以下是 app.js 的基本内容：

const express = require('express');
const path = require('path');
const cookieParser = require('cookie-parser');
const logger = require('morgan');

const indexRouter = require('./routes/index');

const app = express();

app.use(logger('dev'));
app.use(express.json());
app.use(express.urlencoded({ extended: false }));
app.use(cookieParser());
app.use(express.static(path.join(__dirname, 'public')));

app.use('/', indexRouter);

module.exports = app;

• 引入必要的 Node.js 模块，如 express、path、cookie-parser 和 logger。
• 引入自定义的 indexRouter 路由。
• 设置中间件，如日志记录、解析JSON和URL编码的请求体、解析cookie等。
• 设置静态资源目录。
• 使用 indexRouter 路由来处理根URL的请求。
• 导出 app 对象，以便在其他模块中使用。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，主要包括 app.json 和 database.json。

app.json 配置文件

{
  "port": 3000,
  "title": "Starguard"
}

• port：指定应用程序监听的端口号，默认为3000。
• title：应用程序的标题。

database.json 配置文件

{
  "host": "localhost",
  "user": "root",
  "password": "password",
  "database": "starguard_db"
}

• host：数据库服务器地址，默认为 localhost。
• user：数据库用户名。
• password：数据库密码。
• database：数据库名称。

以上是 Starguard 项目的启动与配置的基本教程，希望对您的开发有所帮助。