<h1 align="center"><a href="https://blog.santoshshinde.com/skeleton-for-node-js-apps-written-in-typescript-444fa1695b30" target="_blank">Node-Typescript-样板项目</a></h1> <p align="center">用TypeScript编写的Node.js应用程序骨架</p> <p align="center"> <a href="https://sonarcloud.io/project/overview?id=santoshshinde2012_node-boilerplate"> <img src="https://sonarcloud.io/api/project_badges/measure?project=santoshshinde2012_node-boilerplate&metric=alert_status" alt="质量门状态" /> </a> <a href="https://github.com/santoshshinde2012/node-boilerplate/actions/workflows/ci.yml" target="_blank"> <img src="https://yellow-cdn.veclightyear.com/87312a0a/74f6cb90-fad6-4377-8841-5cd166c598f3.svg?branch=master" alt="Github action工作流状态" /> </a> <a href="https://codeclimate.com/github/santoshshinde2012/node-boilerplate/maintainability" target="_blank"> <img src="https://api.codeclimate.com/v1/badges/ad13a11cffa2421a8220/maintainability" alt="可维护性" /> </a> <a href="https://codeclimate.com/github/santoshshinde2012/node-boilerplate/test_coverage" target="_blank"> <img src="https://api.codeclimate.com/v1/badges/ad13a11cffa2421a8220/test_coverage" alt="测试覆盖率" /> </a> <a href="https://snyk.io/test/github/santoshshinde2012/node-boilerplate" target="_blank"> <img src="https://yellow-cdn.veclightyear.com/87312a0a/e4d4446b-06a8-4ab1-8186-b38c2cffee98.svg?style=flat-square" alt="" /> </a> <a href="https://libraries.io/github/santoshshinde2012/node-boilerplate" target="_blank"> <img src="https://img.shields.io/librariesio/github/santoshshinde2012/node-boilerplate" alt="" /> </a> </p>

目的

我们创建这个骨架项目的主要目的是用Node.js和TypeScript启动服务器应用程序。 试试看！我很乐意听到您的反馈或任何新功能的建议。

常见特性

• 快速启动
• 基于TypeScript语法的简单脚手架
• 易于全局环境配置和错误处理
• 灵活添加新功能
• 持续集成
• 添加了Github Action工作流
• sonarcloud.io
• snyk.io
• CodeQL
• njsscan 是一个静态应用程序测试（SAST）工具，可以在您的node.js应用程序中找到不安全的代码模式
• Codeclimate
• <a href="https://codeclimate.com/github/santoshshinde2012/node-boilerplate/maintainability"><img src="https://api.codeclimate.com/v1/badges/0e53f5d93de102b39641/maintainability" /></a>
• <a href="https://codeclimate.com/github/santoshshinde2012/node-boilerplate/test_coverage"><img src="https://api.codeclimate.com/v1/badges/0e53f5d93de102b39641/test_coverage" /></a>
• 文档标准
• 支持Swagger文档和Postman集合
• readme文件中的清晰说明
• 测试覆盖率维护
• 全面的测试覆盖，集成了eslint、prettier和husky
• 生产就绪设置
• 遵循安全和效率的最佳实践
• 集成了Winston日志记录器，仅包含必要的npm模块

核心NPM模块

• express, @types/express
• @types/node
• typescript
• dotenv
• cors
• helmet
• http-status-codes
• winston

启动应用程序

在开发模式下启动应用程序

• 克隆应用程序 git clone https://github.com/santoshshinde2012/node-boilerplate.git
• 安装依赖 npm install
• 启动应用程序 npm run dev

在生产模式下启动应用程序

• 安装依赖 npm install
• 创建构建 npm run build
• 启动应用程序 npm run start
• 启动前请确保更新您的 .env 值，可参考 .env.example

项目结构

名称	描述
wiki/	您可以在这里添加项目文档和说明文件
src/	源文件
src/abstractions	抽象类和接口
src/components	REST API 组件和控制器
src/lib	可重用的实用程序和库源代码，如日志记录器
src/middleware/	Express 中间件，如错误处理功能
build/	编译后的源文件将放置在这里
tests/	测试用例将放置在这里
tests/helpers/	测试用例的辅助函数将放置在这里
tests/unit-tests/	单元测试用例将放置在这里
tests/integration-tests/	API 路由（集成）测试用例将放置在这里

工作流程

加密

将 APPLY_ENCRYPTION 环境变量设置为 true 以启用加密。

Swagger API 文档

Swagger 文档可在以下 URL 获取 ${host}/docs： http://localhost:8080/docs

默认系统健康状态 API

• ${host}/api/system/info - 在响应中返回系统信息
• ${host}/system/time - 在响应中返回当前时间
• ${host}/system/usage - 在响应中返回进程和系统内存使用情况
• ${host}/system/process - 在响应中返回进程详情
• ${host}/system/error - 在响应中返回生成的错误对象

Postman 集合

参考资料

• 用 TypeScript 编写的 Node.js 应用程序骨架
• 在 Node JS TypeScript 项目中设置 Eslint Prettier 和 Husky

注意事项

1. 为什么我的 git pre-commit 钩子默认不可执行？

• 因为文件默认不可执行；必须将它们设置为可执行。

chmod ug+x .husky/*
chmod ug+x .git/hooks/*

2. 生产最佳实践：安全性

• 不要使用过时或有漏洞的 Express 版本
• 使用 TLS
• 使用 Helmet
• 安全地使用 cookies
• 防止针对授权的暴力攻击
• 确保您的依赖项是安全的
• 避免其他已知漏洞
• 其他注意事项

3. 教程

• 用 TypeScript 编写的 Node.js 应用程序骨架（包括 ESLint、Prettier 和 Husky 的设置说明）
• 使用 Express 和 TypeScript 在 Node JS 中实现全局错误和响应处理
• TypeScript 和 Node.js 中使用 Jest 进行测试的初学者指南
• 使用 SonarQube 对 Node.js 和 TypeScript 项目进行静态代码分析
• Node.js 事件发射器的可视化

<hr/>

与我联系

<div id="badges"> <a href="https://twitter.com/shindesan2012"> <img src="https://img.shields.io/badge/shindesan2012-black?style=for-the-badge&logo=twitter&logoColor=white" alt="Twitter 徽章"/> </a> <a href="https://www.linkedin.com/in/shindesantosh/"> <img src="https://img.shields.io/badge/shindesantosh-blue?style=for-the-badge&logo=linkedin&logoColor=white" alt="LinkedIn 徽章"/> </a> <a href="https://blog.santoshshinde.com/"> <img src="https://img.shields.io/badge/Blog-black?style=for-the-badge&logo=medium&logoColor=white" alt="Medium 徽章"/> </a> <a href="https://www.buymeacoffee.com/santoshshin" target="_blank"> <img src="https://yellow-cdn.veclightyear.com/87312a0a/eca721de-fb7b-4014-95b0-5a71cea9b6be.png" alt="为我买杯咖啡" height="28" width="100"> </a> </div>