Bailan 项目使用教程
1. 项目目录结构及介绍
Bailan/
├── app/
│ ├── controllers/
│ ├── models/
│ ├── views/
│ └── routes.js
├── config/
│ ├── database.js
│ ├── environment.js
│ └── settings.js
├── public/
│ ├── css/
│ ├── js/
│ └── images/
├── test/
│ ├── unit/
│ └── integration/
├── .env
├── .gitignore
├── package.json
├── README.md
└── server.js
目录结构说明
-
app/: 包含应用程序的主要代码,包括控制器、模型、视图和路由。
- controllers/: 存放控制器文件,处理业务逻辑。
- models/: 存放数据模型文件,定义数据结构和操作。
- views/: 存放视图文件,通常是HTML模板。
- routes.js: 定义应用程序的路由。
-
config/: 包含项目的配置文件。
- database.js: 数据库配置文件。
- environment.js: 环境配置文件,如开发、测试、生产环境配置。
- settings.js: 其他全局设置。
-
public/: 存放静态资源文件,如CSS、JavaScript和图片。
- css/: 存放CSS样式文件。
- js/: 存放JavaScript脚本文件。
- images/: 存放图片资源。
-
test/: 包含测试代码。
- unit/: 单元测试文件。
- integration/: 集成测试文件。
-
.env: 环境变量配置文件,通常用于存储敏感信息。
-
.gitignore: Git忽略文件,指定哪些文件或目录不需要被Git管理。
-
package.json: 项目依赖和脚本配置文件。
-
README.md: 项目说明文档。
-
server.js: 项目启动文件。
2. 项目启动文件介绍
server.js
server.js
是项目的启动文件,负责启动应用程序的服务器。以下是 server.js
的主要内容:
const express = require('express');
const app = express();
const config = require('./config/environment');
// 加载配置
app.set('port', config.port);
// 加载路由
require('./app/routes')(app);
// 启动服务器
app.listen(app.get('port'), () => {
console.log(`Server is running on port ${app.get('port')}`);
});
启动步骤
- 安装依赖: 在项目根目录下运行
npm install
安装所有依赖。 - 启动服务器: 运行
npm start
启动服务器。
3. 项目的配置文件介绍
config/database.js
database.js
文件用于配置数据库连接信息。以下是一个示例配置:
module.exports = {
development: {
username: 'root',
password: 'password',
database: 'bailan_dev',
host: '127.0.0.1',
dialect: 'mysql',
},
test: {
username: 'root',
password: 'password',
database: 'bailan_test',
host: '127.0.0.1',
dialect: 'mysql',
},
production: {
username: process.env.DB_USERNAME,
password: process.env.DB_PASSWORD,
database: process.env.DB_NAME,
host: process.env.DB_HOST,
dialect: 'mysql',
},
};
config/environment.js
environment.js
文件用于配置不同环境下的设置。以下是一个示例配置:
module.exports = {
development: {
port: 3000,
debug: true,
},
test: {
port: 3001,
debug: false,
},
production: {
port: process.env.PORT || 8080,
debug: false,
},
};
config/settings.js
settings.js
文件用于配置全局设置。以下是一个示例配置:
module.exports = {
defaultLanguage: 'zh-CN',
maxUploadSize: '5mb',
};
通过以上配置文件,可以根据不同的环境(开发、测试、生产)进行相应的设置。