rabbitfund_backend

Install

• npm install
  

• 建立 .env (格式請參考 example.env)

How to use

開發

npm run start

測試

npm run test

計算測試覆蓋率

npm run coverage

詳細測試報告在 /coverage/index.html

透過 postman 產生 openAPI 文件

npm run postman

postman collection 檔案在這裡

隨機生成資料

npm run create

# or

npm run create -- <filenames>  

• filenames 只能是以下這幾種
  • users
  • proposers
  • projects
  • options
  • qas
  • news
  • orders
  • orderInfos
  • likes

例如： node src/db/createData.js users proposers 就只會更新 users.json 和 proposers.json 這兩個檔案

初始化資料庫的資料

npm run init

資料檔案在這裡

建置流程

參考此文件

---

技術

後端框架

Express

• 為熱門的 Node.js 網頁框架

資料庫

MongoDB (Atlas)

假資料準備

• 產生假資料的腳本
• 初始化資料庫腳本
• 準備假資料的細節

1. 使用 chatGPT 產生專案的文案
2. 撰寫腳本，將文案整理成合適的格式，並加上隨機的數字、日期等
3. 將建立好的資料上傳到資料庫

CI/CD

Vitest

• 測試檔案位置
• 大部分 API 功能都有寫測試，目前先以應當成功執行的測試為主
• 覆蓋率 (c8) (報告連結)

Github Actions

• 設定檔
• 由 Github Actions 負責 CI，每次更新都會執行 Vitest 的測試

Render

• 專案部屬位置
• 在 Render 部屬專案，可以做到自動化部屬 (CD)

API 文件

Swagger

• 文件連結 (版本一)

  swagger-autogen 產生

• 文件連結 (版本二)

  postman-to-openapi 產生

串接服務

藍新金流

• 整合藍新金流供贊助募資專案時使用

Firebase

• 負責儲存圖片

Uptimerobot

• 定時確認後端狀態，並確保後端隨時都可以迅速回應

  為了避免 Uptimerobot 失靈，也有同時使用 Github Actions 定時呼叫後端服務 (設定檔)

Discord Webhook

• Github
  • 有 push 和 PR 時會收到通知
  • 方便快速查看 commit
• Uptimerobot
  • 可即時收到後端服務處於非活躍狀態的提示