Nana 开源项目教程
nanaLua http api framework项目地址:https://gitcode.com/gh_mirrors/nana1/nana
1. 项目的目录结构及介绍
nana/
├── README.md
├── LICENSE
├── package.json
├── src/
│ ├── index.js
│ ├── config/
│ │ ├── default.json
│ │ ├── production.json
│ ├── routes/
│ │ ├── index.js
│ │ ├── users.js
│ ├── models/
│ │ ├── user.js
│ ├── controllers/
│ │ ├── userController.js
│ ├── utils/
│ │ ├── helper.js
├── public/
│ ├── index.html
│ ├── styles.css
目录结构说明
- README.md: 项目介绍和使用说明。
- LICENSE: 项目许可证。
- package.json: 项目依赖和脚本配置。
- src/: 源代码目录。
- index.js: 项目入口文件。
- config/: 配置文件目录。
- default.json: 默认配置文件。
- production.json: 生产环境配置文件。
- routes/: 路由文件目录。
- index.js: 主路由文件。
- users.js: 用户相关路由文件。
- models/: 数据模型文件目录。
- user.js: 用户模型文件。
- controllers/: 控制器文件目录。
- userController.js: 用户控制器文件。
- utils/: 工具函数文件目录。
- helper.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 running on port ${PORT}`);
});
启动文件说明
- 引入
express
框架并创建应用实例。 - 加载配置文件
config
。 - 加载路由文件
routes
。 - 使用
express.json()
中间件处理 JSON 请求。 - 监听指定端口(默认 3000)并启动服务器。
3. 项目的配置文件介绍
默认配置文件 src/config/default.json
{
"port": 3000,
"database": {
"host": "localhost",
"user": "root",
"password": "",
"dbname": "nana"
}
}
生产环境配置文件 src/config/production.json
{
"port": 8080,
"database": {
"host": "production-db-host",
"user": "admin",
"password": "strong-password",
"dbname": "nana_production"
}
}
配置文件说明
- port: 服务器监听的端口。
- database: 数据库连接配置。
- host: 数据库主机地址。
- user: 数据库用户名。
- password: 数据库密码。
- dbname: 数据库名称。
配置文件通过环境变量加载,default.json
为默认配置,production.json
为生产环境配置。
nanaLua http api framework项目地址:https://gitcode.com/gh_mirrors/nana1/nana