node-boilerplate

node-boilerplate

Node.js应用程序的TypeScript开发框架

这是一个基于TypeScript的Node.js应用程序开发框架。该项目提供快速启动、持续集成、文档标准和测试覆盖等功能。框架集成了ESLint、Prettier等开发工具,并支持Swagger文档和Winston日志记录。通过简化配置和错误处理,它旨在提高Node.js应用的开发效率。该框架包含简单的脚手架、全局环境配置和必要的npm模块,使其成为一个生产就绪的设置。

Node.jsTypeScript项目模板开发框架持续集成Github开源项目
<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/componentsREST 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}/docshttp://localhost:8080/docs

默认系统健康状态 API

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

Swagger API 文档

Postman 集合

参考资料

注意事项

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

  • 因为文件默认不可执行;必须将它们设置为可执行。
chmod ug+x .husky/*
chmod ug+x .git/hooks/*

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

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

3. 教程

<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>

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多