Fast-Nest -- 基於Nest.js的Node項目啓動框架(Typescript)

久違的背景介紹:)

近期在作一個KOA內部管理系統的框架遷移，在遷移的過程當中逐漸熟悉Nest.js的開發模式，對它的目錄結構設計以及框架自帶的裝飾器支持很有好感，固有將其整合成快速啓動框架的想法。

本項目適用：

• node簡易應用初始化
• node項目初學試驗
• typescript項目初學試驗
• 有興趣的童鞋亦可做爲項目腳手架(項目內都是基礎功能與結構，是能夠做爲簡單的腳手架的)

食用前

• 能夠先去項目內看看Fast-Nest
• 但願使用者有JavaScript基礎，熟悉typescript更佳。
• 但願有簡單node應用開發基礎(可選)
• 但願能先了解Nest.js框架(傳送門)

如何啓動項目

git clone https://github.com/mykurisu/fast-nest.git

cd fase-nest

npm install

npm start
複製代碼

如代碼所示，將本項目克隆至本地，安裝好依賴便可啓動服務，默認端口爲9999，假若須要調整請在根目錄的config.ts中進行調整。

項目啓動後，若是你沒有啓動本地的MongoDB會出現超時的報錯，這時有兩種方案：

① 將share.module中的mongo公共服務掛載刪除

② 啓動MongoDB，鏈接數據庫的配置亦在config.ts內

這個項目內有什麼料

• 一套可運行的nest項目代碼(廢話)
• 小而全的Node項目目錄結構
• 按照核心、功能以及公共三個維度進行模塊劃分
• 核心模塊
  • 內置格式化返回數據的攔截器
  • 內置格式化返回錯誤信息的過濾器
  • 內置簡易日誌中間件
• 公共模塊
  • 內置MongoDB初始化服務
  • 內置騰訊雲靜態儲存初始化服務
• 功能模塊
  • 內置簡易用戶信息獲取模塊
  • 內置文件上傳模塊(支持上傳到騰訊雲)

這個項目將會怎麼樣

會持續維護。至於後續會接入什麼模塊，將視我的業餘時間而定，初步設想會完善有用戶模塊的建設，爭取可以初始化一個較爲通用的用戶模塊。

最後

你們若是玩的舒服，但願可以star支持一下:)