QuorakiAPI

「クォートランキング」
跨世代方便大家語錄評比的API。
錯誤回報 · 功能請求

目錄

1. 關於QuorakiAPI
2. 開始使用
   • 使用方法
   • 自行架設
3. 進行開發
   • 前置作業
   • 啟動開發伺服器
4. 未來計劃
5. 協力開發
6. 授權
7. 聯絡我們
8. 特別感謝

關於QuorakiAPI

這是一個由國立臺南第一高級中學電機社，受黑特南一中2.0之啟發所製作的語錄評比API。
其中Quoraki為「クォート」（語錄）以及「ランキング」（評比）的結合體。這是一個冷笑話，但寓意深遠。

(回到頂部)

開始使用

在開始使用之前，請先確認自己有一顆熱愛評比的心，阿彌陀佛。

使用方法

非常簡單，只要發送GET請求到/api/rank就好了。以下示範：

http://<origin>/api/rank?text=評比南一中&type=quote

參數說明：

• text: 必要。評比的文字。
• type: 非必要。評比的類型。預設是 quote，即「語錄評比」。

詳細的說明請洽 /swagger 頁面，在那邊你也可以找到所有可用的評比類型。

自行架設

1. 確認已經安裝了 Docker。

2. 啟動我們的 Docker Image。

   docker run -p 3000:3000 ghcr.io/tnfshcec/quorakiapi:main

進行開發

前置作業

1. 複製我們的專案到本地。

   git clone https://github.com/tnfshcec/QuorakiAPI.git

2. 確認安裝 Bun。

3. 安裝依賴項目

   bun install

啟動開發伺服器

bun run dev

開發伺服器即會在 localhost:3000 啟動。

(回到頂部)

未來計劃

• 加上更多語錄評比
• Web UI
• 跑路

也可以看看 open issues 看看有沒有誰發了新的想法。

(回到頂部)

協力開發

如果你覺得這個專案有值得改進的地方，歡迎 fork 並更改完後發 PR 給我們，或是在 issue 中提出並加上 enchance 標籤。
別忘了給我們星星，拜託🐔

1. Fork 這個專案
2. 創一個屬於你的功能的分支 (git checkout -b feature/AmazingFeature)
3. Commit 你的變更 (git commit -m 'Add some AmazingFeature')
4. Push 到你的分支 (git push origin feature/AmazingFeature)
5. 開一個 PR

(回到頂部)

授權

我們使用 MIT License. 查看 LICENSE 獲得更多資訊。

(回到頂部)

聯絡我們

臺南一中電機社 - @tnfshcec - 臺南一中電機社 - [email protected]

專案連結： https://github.com/tnfshcec/QuorakiAPI

(回到頂部)

特別感謝

• ElysiaJS

(回到頂部)