Node.js 手册项目教程
1. 项目的目录结构及介绍
node-handbook/
├── .github/
│ └── workflows/
├── assets/
│ └── images/
├── docs/
│ ├── README.md
│ └── ...
├── src/
│ ├── index.js
│ └── ...
├── .gitignore
├── package.json
├── README.md
└── ...
- .github/: 包含 GitHub Actions 的工作流配置文件。
- assets/: 存放项目相关的静态资源,如图片等。
- docs/: 存放项目的文档文件,包括
README.md
等。 - src/: 项目的源代码目录,包含主要的 JavaScript 文件。
- .gitignore: 指定 Git 忽略的文件和目录。
- package.json: 项目的配置文件,包含依赖项、脚本等信息。
- README.md: 项目的介绍文档。
2. 项目的启动文件介绍
项目的启动文件位于 src/index.js
。该文件是项目的入口点,负责初始化应用程序并启动服务。
// src/index.js
const express = require('express');
const app = express();
const port = process.env.PORT || 3000;
app.get('/', (req, res) => {
res.send('Hello World!');
});
app.listen(port, () => {
console.log(`App listening at http://localhost:${port}`);
});
- express: 引入 Express 框架。
- app: 创建 Express 应用程序实例。
- port: 定义应用程序监听的端口。
- app.get('/', ...): 定义根路径的路由处理函数。
- app.listen(...): 启动服务器并监听指定端口。
3. 项目的配置文件介绍
项目的配置文件主要是 package.json
,它包含了项目的元数据和依赖项。
{
"name": "node-handbook",
"version": "1.0.0",
"description": "A handbook for Node.js",
"main": "src/index.js",
"scripts": {
"start": "node src/index.js",
"test": "echo \"Error: no test specified\" && exit 1"
},
"dependencies": {
"express": "^4.17.1"
},
"devDependencies": {
"nodemon": "^2.0.7"
}
}
- name: 项目的名称。
- version: 项目的版本号。
- description: 项目的描述。
- main: 项目的入口文件。
- scripts: 定义可执行的脚本命令,如
start
和test
。 - dependencies: 项目的生产环境依赖。
- devDependencies: 项目的开发环境依赖。