TypeScript Node 项目教程
项目的目录结构及介绍
typescript-node/
├── src/
│ ├── config/
│ ├── controllers/
│ ├── models/
│ ├── routes/
│ ├── services/
│ ├── utils/
│ └── index.ts
├── test/
├── .env
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md
src/
: 包含项目的所有源代码文件。config/
: 存放配置文件。controllers/
: 存放控制器文件。models/
: 存放数据模型文件。routes/
: 存放路由文件。services/
: 存放服务文件。utils/
: 存放工具函数文件。index.ts
: 项目的入口文件。
test/
: 存放测试文件。.env
: 环境变量配置文件。.gitignore
: Git忽略文件配置。package.json
: 项目依赖和脚本配置文件。tsconfig.json
: TypeScript编译配置文件。README.md
: 项目说明文档。
项目的启动文件介绍
项目的启动文件是 src/index.ts
。这个文件通常包含以下内容:
- 导入必要的模块和配置。
- 初始化Express应用。
- 配置中间件。
- 定义路由。
- 启动服务器。
示例代码:
import express from 'express';
import bodyParser from 'body-parser';
import routes from './routes';
const app = express();
const port = process.env.PORT || 3000;
app.use(bodyParser.json());
app.use('/api', routes);
app.listen(port, () => {
console.log(`Server is running on port ${port}`);
});
项目的配置文件介绍
.env
.env
文件用于存储环境变量,例如数据库连接字符串、端口号等。示例内容如下:
PORT=3000
DB_URI=mongodb://localhost:27017/mydatabase
tsconfig.json
tsconfig.json
文件用于配置TypeScript编译选项。示例内容如下:
{
"compilerOptions": {
"target": "ES6",
"module": "commonjs",
"outDir": "./dist",
"rootDir": "./src",
"strict": true,
"esModuleInterop": true
},
"include": ["src/**/*"]
}
package.json
package.json
文件用于管理项目的依赖和脚本。示例内容如下:
{
"name": "typescript-node",
"version": "1.0.0",
"description": "A Node.js project with TypeScript",
"main": "dist/index.js",
"scripts": {
"build": "tsc",
"start": "node dist/index.js",
"dev": "ts-node src/index.ts"
},
"dependencies": {
"express": "^4.17.1"
},
"devDependencies": {
"ts-node": "^10.0.0",
"typescript": "^4.3.2"
}
}
以上是 typescript-node
项目的基本教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助!