Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 1.92 KB

README.md

File metadata and controls

75 lines (51 loc) · 1.92 KB

Field Seating 球場坐座-座位視野共享平台 API

Test

透過群眾上傳,提升看球體驗!看棒球?先來球場坐座,再到球場坐坐!
立即前往使用 --> 球場坐座

API | API 文件

  • Environment: Node.js v16
  • Database: MySQL v8 / Redis

安裝

  1. 開啟終端機(Terminal)cd 到存放專案本機位置並執行:
git clone https://github.com/field-seating/field-seating-api.git
  1. 初始
cd field-seating-api //切至專案資料夾
npm install  //安裝套件
將資料夾內'.env.example'檔案名稱改為'.env'
  1. env 相關
  • DATABASE_URL: 請自行建立 MySQL 資料庫
  • JWT_SECRET: 請自行設定 JasonWebToken
  • REDIS_URL: 請自行設定 redis 連線網址
  • DO_ACCESS_KEY&DO_SECRET: 本產品存放空間使用digitalOcean
  • SENDGRID_API_KEY: 本產品驗證信寄發服務使用sendgrid
  1. 資料庫建置
npm run db:deploy // 載入模組
npm run db:seed // 載入種子資料(樂天桃園棒球場)
node data/20220915_create_xinZhuang_field_data.js // 載入新莊球場資料
  1. 開啟程式
npm run dev

當終端機(terminal)出現以下文字,代表伺服器已啟動

{"level":"info","message":"App listening on port 3000","appEnv":"development"}

測試

  1. 測試範圍:針對商業邏輯主要存在的 service 層及相關工具
  2. 執行測試:
請先安裝docker

npm run container:test  // 測試
npm run container:test:watch  // 測試並持續監聽

使用工具

請參閱 package.json