Guess That Lang 项目教程
1. 项目的目录结构及介绍
guess-that-lang/
├── README.md
├── package.json
├── src/
│ ├── index.js
│ ├── config/
│ │ ├── default.json
│ │ ├── production.json
│ ├── routes/
│ │ ├── api.js
│ ├── controllers/
│ │ ├── languageController.js
│ ├── models/
│ │ ├── languageModel.js
│ ├── utils/
│ │ ├── helper.js
- README.md: 项目说明文档。
- package.json: 项目依赖和脚本配置文件。
- src/: 源代码目录。
- index.js: 项目入口文件。
- config/: 配置文件目录。
- default.json: 默认配置文件。
- production.json: 生产环境配置文件。
- routes/: 路由文件目录。
- api.js: API 路由定义文件。
- controllers/: 控制器文件目录。
- languageController.js: 语言控制器文件。
- models/: 数据模型文件目录。
- languageModel.js: 语言模型文件。
- utils/: 工具函数文件目录。
- helper.js: 辅助函数文件。
2. 项目的启动文件介绍
index.js 是项目的入口文件,负责启动应用。以下是 index.js
的主要内容:
const express = require('express');
const app = express();
const port = process.env.PORT || 3000;
app.use(express.json());
app.use('/api', require('./routes/api'));
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});
- 引入
express
模块并创建应用实例。 - 设置端口为环境变量
PORT
或默认端口3000
。 - 使用
express.json()
中间件处理 JSON 请求。 - 挂载
/api
路由。 - 启动服务器并监听指定端口。
3. 项目的配置文件介绍
config/ 目录包含项目的配置文件,主要有 default.json
和 production.json
。
default.json
{
"port": 3000,
"db": {
"host": "localhost",
"user": "root",
"password": "",
"database": "guess_that_lang"
}
}
- port: 默认端口号。
- db: 数据库配置,包括主机、用户、密码和数据库名。
production.json
{
"port": 8080,
"db": {
"host": "production_host",
"user": "production_user",
"password": "production_password",
"database": "guess_that_lang_prod"
}
}
- port: 生产环境端口号。
- db: 生产环境数据库配置。
这些配置文件通过环境变量加载,确保不同环境下的配置分离。