-
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #116 from SCAICT/development
README i18n
- Loading branch information
Showing
3 changed files
with
247 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| <!-- markdownlint-disable first-line-h1 --> | ||
| <!-- markdownlint-disable html --> | ||
|
|
||
| <div align="center"> | ||
| <img src="uwu.png" width="200px" alt="中電喵 SCAICT uwu"> | ||
|
|
||
| # 中電喵 SCAICT uwu | ||
|
|
||
| 住在中電會 Discord 伺服器的貓咪 | ||
|
|
||
| [](https://github.com/SCAICT/SCAICT-uwu/actions/workflows/notion.yml) | ||
| [](https://scaict.org/) | ||
| [](https://store.scaict.org/) | ||
| [](https://dc.scaict.org) | ||
| [](https://www.instagram.com/scaict.tw/) | ||
|
|
||
| </div> | ||
|
|
||
| > 這個專案目前處於開發階段，並且可能會有一些問題。如果您發現了任何問題或有任何建議，請透過提交 issue 來通知我們。 | ||
| ## 如何部署？ | ||
|
|
||
| 1. clone 此儲存庫。 | ||
| 2. 在 Python 3.11 中建立環境。 | ||
| 3. 安裝必要的函式庫。 | ||
|
|
||
| ```bash | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| 4. 在 `DataBase/server.config.json` 中設定頻道。 | ||
| 5. 啟動 SQL 伺服器。 | ||
| 6. 在 Breadcrumbs SCAICT-uwu 的 `cog/core/sql_acc.py` 中設定 SQL 伺服器。 | ||
| 7. 執行 Flask。 | ||
|
|
||
| ```bash | ||
| flask run | ||
| ``` | ||
|
|
||
| 8. 執行 `main.py`。 | ||
|
|
||
| ```bash | ||
| python main.py | ||
| ``` | ||
|
|
||
| ## 檔案 | ||
|
|
||
| * `main.py`：中電喵。 | ||
| * `app.py`：中電商店。 | ||
| * `generate_secrets.py`：為 `app.py` 產生密鑰，執行後儲存在 `token.json` 中。 | ||
| * 資料庫 MySQL：使用外部伺服器，相關設定在 `cog/core/secret.py` 中。 | ||
| * `token.json`： | ||
|
|
||
| ```json | ||
| { | ||
| "discord_token": "", | ||
| "secret_key": "", | ||
| "discord_client_id": "", | ||
| "discord_client_secret": "", | ||
| "discord_redirect_uri": "http://127.0.0.1:5000/callback", | ||
| "github_client_id": "", | ||
| "github_client_secret": "", | ||
| "github_redirect_uri": "http://127.0.0.1:5000/github/callback", | ||
| "github_discord_redirect_uri": "http://127.0.0.1:5000/github/discord-callback" | ||
| } | ||
| ``` | ||
|
|
||
| * `DataBase/slot.json`： | ||
|
|
||
| 設定老虎機的中獎機率。 | ||
|
|
||
| ```json | ||
| { | ||
| "element": [ percentage, reward ] | ||
| } | ||
| ``` | ||
|
|
||
| > 更詳細的說明文件敘述可以參考[這裡](https://g.scaict.org/doc/) | ||
| ## 鳴謝 | ||
|
|
||
| 中電喵是由中電會和[貢獻者們](https://github.com/SCAICT/SCAICT-uwu/graphs/contributors)共同開發和維護的專案。角色設計由[毛哥 EM](https://elvismao.com/) 和[瑞樹](https://www.facebook.com/ruishuowo)創作，而部分圖示則選用了來自 [Freepik - Flaticon](https://www.flaticon.com/free-icons/slot-machine) 的設計素材。 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| <!-- markdownlint-disable first-line-h1 --> | ||
| <!-- markdownlint-disable html --> | ||
|
|
||
| <div align="center"> | ||
| <img src="uwu.png" width="200px" alt="中電喵 SCAICT uwu"> | ||
|
|
||
| # 中電喵 SCAICT uwu | ||
|
|
||
| 住在中電會 Discord 伺服器的貓咪 | ||
|
|
||
| [](https://github.com/SCAICT/SCAICT-uwu/actions/workflows/notion.yml) | ||
| [](https://scaict.org/) | ||
| [](https://store.scaict.org/) | ||
| [](https://dc.scaict.org) | ||
| [](https://www.instagram.com/scaict.tw/) | ||
|
|
||
| </div> | ||
|
|
||
| > 這個專案目前處於開發階段，並且可能會有一些問題。如果您發現了任何問題或有任何建議，請透過提交 issue 來通知我們。 | ||
|
|
||
| ## 如何部署？ | ||
|
|
||
| 1. clone 此儲存庫。 | ||
| 2. 在 Python 3.11 中建立環境。 | ||
| 3. 安裝必要的函式庫。 | ||
|
|
||
| ```bash | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| 4. 在 `DataBase/server.config.json` 中設定頻道。 | ||
| 5. 啟動 SQL 伺服器。 | ||
| 6. 在 Breadcrumbs SCAICT-uwu 的 `cog/core/sql_acc.py` 中設定 SQL 伺服器。 | ||
| 7. 執行 Flask。 | ||
|
|
||
| ```bash | ||
| flask run | ||
| ``` | ||
|
|
||
| 8. 執行 `main.py`。 | ||
|
|
||
| ```bash | ||
| python main.py | ||
| ``` | ||
|
|
||
| ## 檔案 | ||
|
|
||
| * `main.py`：中電喵。 | ||
| * `app.py`：中電商店。 | ||
| * `generate_secrets.py`：為 `app.py` 產生密鑰，執行後儲存在 `token.json` 中。 | ||
| * 資料庫 MySQL：使用外部伺服器，相關設定在 `cog/core/secret.py` 中。 | ||
| * `token.json`： | ||
|
|
||
| ```json | ||
| { | ||
| "discord_token": "", | ||
| "secret_key": "", | ||
| "discord_client_id": "", | ||
| "discord_client_secret": "", | ||
| "discord_redirect_uri": "http://127.0.0.1:5000/callback", | ||
| "github_client_id": "", | ||
| "github_client_secret": "", | ||
| "github_redirect_uri": "http://127.0.0.1:5000/github/callback", | ||
| "github_discord_redirect_uri": "http://127.0.0.1:5000/github/discord-callback" | ||
| } | ||
| ``` | ||
|
|
||
| * `DataBase/slot.json`： | ||
|
|
||
| 設定老虎機的中獎機率。 | ||
|
|
||
| ```json | ||
| { | ||
| "element": [ percentage, reward ] | ||
| } | ||
| ``` | ||
|
|
||
| > 更詳細的說明文件敘述可以參考[這裡](https://g.scaict.org/doc/) | ||
|
|
||
| ## 鳴謝 | ||
|
|
||
| 中電喵是由中電會和[貢獻者們](https://github.com/SCAICT/SCAICT-uwu/graphs/contributors)共同開發和維護的專案。角色設計由[毛哥 EM](https://elvismao.com/) 和[瑞樹](https://www.facebook.com/ruishuowo)創作，而部分圖示則選用了來自 [Freepik - Flaticon](https://www.flaticon.com/free-icons/slot-machine) 的設計素材。 |