isauth 项目使用教程
1. 项目的目录结构及介绍
isauth/
├── README.md
├── package.json
├── src/
│ ├── index.js
│ ├── config/
│ │ ├── default.json
│ │ ├── production.json
│ ├── routes/
│ │ ├── index.js
│ │ ├── auth.js
│ ├── controllers/
│ │ ├── authController.js
│ ├── models/
│ │ ├── userModel.js
│ ├── utils/
│ │ ├── authUtils.js
├── public/
│ ├── index.html
│ ├── styles.css
目录结构介绍
- README.md: 项目说明文件。
- package.json: 项目依赖和脚本配置文件。
- src/: 源代码目录。
- index.js: 项目启动文件。
- config/: 配置文件目录。
- default.json: 默认配置文件。
- production.json: 生产环境配置文件。
- routes/: 路由文件目录。
- index.js: 主路由文件。
- auth.js: 认证相关路由文件。
- controllers/: 控制器文件目录。
- authController.js: 认证控制器文件。
- models/: 数据模型文件目录。
- userModel.js: 用户模型文件。
- utils/: 工具函数文件目录。
- authUtils.js: 认证相关工具函数文件。
- public/: 静态资源目录。
- index.html: 主页面文件。
- styles.css: 样式文件。
2. 项目的启动文件介绍
src/index.js
const express = require('express');
const app = express();
const config = require('./config');
const routes = require('./routes');
app.use(express.json());
app.use('/', routes);
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
console.log(`Server is running on port ${PORT}`);
});
启动文件介绍
- 引入依赖: 引入了
express
框架和项目内部的config
和routes
模块。 - 配置中间件: 使用
express.json()
中间件来解析 JSON 请求体。 - 挂载路由: 将路由挂载到应用上。
- 启动服务器: 监听指定端口(默认3000)并启动服务器。
3. 项目的配置文件介绍
src/config/default.json
{
"port": 3000,
"jwtSecret": "your_jwt_secret",
"database": {
"host": "localhost",
"user": "root",
"password": "",
"database": "isauth"
}
}
src/config/production.json
{
"port": 8080,
"jwtSecret": "your_production_jwt_secret",
"database": {
"host": "production_host",
"user": "production_user",
"password": "production_password",
"database": "isauth_production"
}
}
配置文件介绍
- default.json: 默认配置文件,包含开发环境的端口、JWT 密钥和数据库配置。
- production.json: 生产环境配置文件,包含生产环境的端口、JWT 密钥和数据库配置。
这些配置文件通过 config
模块加载,可以根据环境变量自动选择相应的配置文件。