From 619b90cd3a0ba77909d7e86251943cdab681de47 Mon Sep 17 00:00:00 2001 From: Chaiwat Suwannarat Date: Fri, 10 May 2024 18:33:06 +0700 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=91=20Update=20document=20information.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 91 ++++++++++----------- documents/README.en-US.md | 162 ++++++++++++++++++++------------------ documents/README.th.md | 81 ++++++++++--------- 3 files changed, 172 insertions(+), 162 deletions(-) diff --git a/README.md b/README.md index 4599b497..9842b89b 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,15 @@
-

Shioru

+

Shioru

Personal assistants in Discord that will help make your guild a better place.

- - - - - - - - + + + @@ -28,12 +26,13 @@ Your best personal assistants will help your guild look more lively. She can do so many things that you can easily see detailed information on all commands by typing `/help`.
- - + +
-## Outstanding features +## ✨ Outstanding features - Works on [Discord.js](https://discord.js.org/) v14 - A wide variety of customizations can be made. @@ -48,17 +47,17 @@ Your best personal assistants will help your guild look more lively. She can do And many other interesting features... -## Prerequisites +## 🧩 Prerequisites - [Node.js](https://nodejs.org/) v18.0.0 or higher - [Python](https://www.python.org/downloads/) v3.8.0 or higher - [Java](https://www.oracle.com/java/technologies/downloads/) v11.0.0 or higher -- [Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) or [manual install](#1-install-build-tools) - [Firebase Tools](https://firebase.google.com/docs/cli) +- [Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) - [FFmpeg](https://ffmpeg.org/download.html) - [Git](https://git-scm.com/downloads) -## Installation +## ⌛ Installation ### 1. Install **Build Tools** @@ -66,18 +65,20 @@ Install **Build tools** by running the following command according to your opera - For Linux and MacOS operating systems -```sh -sudo apt update -sudo apt install build-essential -``` + ```sh + sudo apt update + sudo apt install build-essential + ``` - For Windows operating system + ```sh + npm install --global --production --add-python-to-path windows-build-tools + ``` -```sh -npm install --global --production --add-python-to-path windows-build-tools -``` - -> **💡 TIP**: You can skip this step through the Node.js installer as shown in the following image. ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/node-js-tools-for-native-modules.png) +> [!TIP] +> You can skip this step by checking the **Automatically install the necessary tools** option through the Node.js installer as shown in the following image. +> +> ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/node-js-tools-for-native-modules.png) ### 2. Clone the bot and install the components. @@ -88,7 +89,8 @@ npm install --global --production --add-python-to-path windows-build-tools npm install ``` - Change the file name `.env.example` to `.env` and enter all required values. - > **💡 NOTE**: You can edit some data in **config** at [./source/configs/data.js](./source/configs/data.js). + > [!NOTE] + > You can edit some data in **config** at [./source/configs/data.js](./source/configs/data.js). ### 3. Setup bot and invite to join. @@ -112,7 +114,8 @@ npm install --global --production --add-python-to-path windows-build-tools - Open a terminal and run `npm run emulators` to simulate the database system in **dev mode**. - Open a new terminal and run the command `npm run dev`. - > **💡 NOTE**: When you enter development mode. Some features may be disabled, such as sending statistics, updating data, etc. + > [!NOTE] + > When you enter development mode. Some features may be disabled, such as sending statistics, updating data, etc. ## ☕ Serve @@ -120,7 +123,8 @@ Test the actual use by performing tasks similar to real use. The system will aut - Open a terminal and run `npm run emulators` to simulate the database system in **emulation mode**. - Open a new terminal and run the command `npm run serve`. - > **💡 NOTE:** You will automatically enter development mode as this is a production simulation. Cause some features may not work. + > [!NOTE] + > You will automatically enter development mode as this is a production simulation. Cause some features may not work. ## 🍵 Production @@ -156,36 +160,27 @@ This operation requires [Docker](https://www.docker.com/products/docker-desktop/ - Use the command `npm run docker:build` and wait for all the work to complete. - Then open the Docker program and run it with the required environment information (env) or use the command `npm run docker:run` and wait until the bot is running. - > **💡 NOTE**: You can check the functionality using the command `docker ps -a`. + > [!TIP] + > You can check the functionality using the command `docker ps -a`. -## Quick Troubleshooting +## ⚡ Quick Troubleshooting -### `gyp ERR! stack Error: not found: make` +- `gyp ERR! stack Error: not found: make` -This problem may be caused by **Build tools** being installed incorrectly or may not have been installed yet. This problem can be solved by looking at the [installation](#1-install-build-tools) section. + This problem may be caused by **Build tools** being installed incorrectly or may not have been installed yet. This problem can be solved by looking at the [installation](#1-install-build-tools) section. -### `@firebase/firestore: Firestore (10.6.0): GrpcConnection RPC 'Write' stream 0x58a118ce error. Code: 14 Message: 14 UNAVAILABLE: No connection established. Last error: connect ECONNREFUSED 127.0.0.1:8080` +- `GrpcConnection RPC 'Write' stream 0x58a118ce error. Code: 14 Message: 14 UNAVAILABLE: No connection established. Last error: connect ECONNREFUSED 127.0.0.1:8080` -It is possible that you have not yet simulated the database system on the machine in test mode. You can solve this problem by closing the bot and running the following command on another page. + It is possible that you have not yet simulated the database system on the machine in test mode. You can solve this problem by closing the bot and running the following command on another page. -```bat -npm run emulators -``` + ```bat + npm run emulators + ``` -## Improve Translate +## 🌐 Improve Translate You can help us translate existing languages or languages that are not currently available on [Crowdin](https://crowdin.com/project/shioru). -## Credits - -Thank you to all the original creators for allowing us to use these wonderful works of yours. - -Personal drawing by: [夏月 まりな (NATSUKI MARINA)](https://www.pixiv.net/en/users/482462)/[お着替え中](https://www.pixiv.net/en/artworks/76075098) - -## Found a problem +## ⚠️ Found a problem If you encounter any problems from your current job You can let us know through the tab. [issue](https://github.com/Maseshi/Shioru/issues) of this repository. - -## Google Translate - -The content of this document has been translated by the [Google Translate](https://translate.google.com/) service. We apologize for any errors. diff --git a/documents/README.en-US.md b/documents/README.en-US.md index 0db9b118..9842b89b 100644 --- a/documents/README.en-US.md +++ b/documents/README.en-US.md @@ -1,17 +1,15 @@
-

Shioru

-

เลขาส่วนตัวใน Discord ที่จะช่วยทำให้กิลด์ของคุณน่าอยู่ยิ่งขึ้น

+

Shioru

+

Personal assistants in Discord that will help make your guild a better place.

- - - - - - - - + + + @@ -25,15 +23,16 @@ [Switch Languages](https://github.com/Maseshi/Shioru/tree/main/documents) -เลขาส่วนตัวที่ดีที่สุดของคุณจะช่วยให้กิลด์ของคุณดูมีชีวิตชีวามากขึ้น เธอสามารถทำสิ่งต่าง ๆ ได้หลายอย่างซึ่งคุณสามารถดูรายละเอียดข้อมูลของคำสั่งทั้งหมด ได้ง่าย ๆ โดยพิมพ์ `/help` +Your best personal assistants will help your guild look more lively. She can do so many things that you can easily see detailed information on all commands by typing `/help`.
- - + +
-## Outstanding features +## ✨ Outstanding features - Works on [Discord.js](https://discord.js.org/) v14 - A wide variety of customizations can be made. @@ -43,86 +42,95 @@ - Support customization of server notifications - You can chat by typing `@Shioru` followed by the message you wish to communicate. - Able to use application commands (/) -- จำลองระบบฐานข้อมูลสำหรับทดสอบ -- รองรับการทำงานบน Shard +- Simulate a database system for testing +- Supports working on shards And many other interesting features... -## Prerequisites +## 🧩 Prerequisites -- [Node.js](https://nodejs.org/) v20.6.0 หรือมากกว่า -- [Python](https://www.python.org/downloads/) v3.8.0 หรือมากกว่า -- [Java](https://www.oracle.com/java/technologies/downloads/) v11.0.0 หรือมากกว่า -- [Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) หรือ[ติดตั้งด้วยตัวเอง](#1-ติดตั้ง-build-tools) +- [Node.js](https://nodejs.org/) v18.0.0 or higher +- [Python](https://www.python.org/downloads/) v3.8.0 or higher +- [Java](https://www.oracle.com/java/technologies/downloads/) v11.0.0 or higher - [Firebase Tools](https://firebase.google.com/docs/cli) -- [FFmpeg](https://www.ffmpeg.org/download.html) +- [Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) +- [FFmpeg](https://ffmpeg.org/download.html) - [Git](https://git-scm.com/downloads) -## การติดตั้ง - -### 1. ติดตั้ง **Build Tools** +## ⌛ Installation -ทำการติดตั้ง **Build tools** โดยรันคำสั่งดังต่อไปนี้ตามระบบปฏิบัติการของคุณ +### 1. Install **Build Tools** -- สำหรับระบบปฏิบัติการ Linux และ MacOS +Install **Build tools** by running the following command according to your operating system. -```sh -sudo apt update -sudo apt install build-essential -``` +- For Linux and MacOS operating systems -- สำหรับระบบปฏิบัติการ Windows + ```sh + sudo apt update + sudo apt install build-essential + ``` -```sh -npm install --global --production --add-python-to-path windows-build-tools -``` +- For Windows operating system + ```sh + npm install --global --production --add-python-to-path windows-build-tools + ``` -> **💡 ทริป**: คุณสามารถข้ามขั้นตอนนี้ผ่านตัวติดตั้ง Node.js ดังภาพต่อไปนี้ ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/node-js-tools-for-native-modules.png) +> [!TIP] +> You can skip this step by checking the **Automatically install the necessary tools** option through the Node.js installer as shown in the following image. +> +> ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/node-js-tools-for-native-modules.png) -### 2. โคลนบอทและติดตั้งส่วนประกอบ +### 2. Clone the bot and install the components. -- Launch a terminal and run the following commands. +- Launch a terminal and run the following command. ```bat git clone https://github.com/Maseshi/Shioru.git cd Shioru npm install ``` -- Rename the `.env.example` file to `.env` and add all values. - - > **💡 หมายเหตุ:** คุณสามารถแก้ไขข้อมูลบางอย่างใน **config** ที่ [./source/configs/data.js](../source/configs/data.js) +- Change the file name `.env.example` to `.env` and enter all required values. + > [!NOTE] + > You can edit some data in **config** at [./source/configs/data.js](./source/configs/data.js). -### 3. ตั้งค่าบอทและเชิญเข้าร่วม +### 3. Setup bot and invite to join. -- Go to the [Discord Developer Portal](https://discord.com/developers/applications) -- Click **"New Application"** and give your bot a name and accept the Discord policy rules. -- Go to the **"Bot"** page and enable all options in the **Privileged Gateway Intents** section. ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/discord-developer-portal-privileged-gateway-intents.png) -- เชิญบอทของคุณไปที่เซิร์ฟเวอร์โดยไปที่หน้า **OAuth2 > URL Generator** เลือก `bot` และ `applications.commands` เลือก `Administrator` จากนั้นคัดลอกลิงก์และวางในแถบที่อยู่ของเบราว์เซอร์ของคุณ ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/discord-developer-portal-scopes.png) +- Go to [Discord Developer Portal](https://discord.com/developers/applications) +- Click **"New Application"** and name your bot and accept the Discord policy rules. +- Go to the **"Bot"** page and enable all options in the **Privileged Gateway Intent** section. + ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/discord-developer-portal-privileged-gateway-intents.png) +- Invite your bot to the server by going to the **OAuth2 > URL Generator** page, selecting `bot` and `applications.commands`, selecting `Administrator`, then copy the link and paste it in the browser address bar. Your sir + ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/discord-developer-portal-scopes.png) -### 4. ตั้งค่าฐานข้อมูล +### 4. Setup database - Go to https://firebase.google.com/ and start setting up the project. -- Add a new project and go through the steps. -- Add your first application with **Website**, name your app without the need to select **"Also set up Firebase Hosting for this app."** and register the app. ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/firebase-setup-web-application.png) -- Firebase จะให้ข้อมูลเกี่ยวกับการกำหนดค่าแก่คุณ นำค่าเหล่านี้ไปใช้กับไฟล์ `.env` +- Add a new project and follow the steps. +- Add your first application with **Website** Name your app without needing to select the **"Also set up Firebase Hosting for this app."** option and register the app. + ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/firebase-setup-web-application.png) +- Firebase will provide you with information about its configuration. Apply these values to the file. `.env` - Go to **Build > [Realtime Database](https://console.firebase.google.com/u/0/project/_/database/data)** to create a database for storing data. -## 🪛 การพัฒนา +## 🪛 Development -- เปิดเทอร์มินัลแล้วรัน `npm run emulators` เพื่อจำลองระบบฐานข้อมูลใน**โหมดพัฒนา** -- เปิดเทอร์มินัลหน้าใหม่แล้วรันคำสั่ง `npm run dev` > **💡 หมายเหตุ:** เมื่อคุณเข้าสู่โหมดการพัฒนา คุณลักษณะบางอย่างอาจถูกปิดใช้งาน เช่น การส่งสถิติ การอัปเดตข้อมูล เป็นต้น +- Open a terminal and run `npm run emulators` to simulate the database system in **dev mode**. +- Open a new terminal and run the command `npm run dev`. + > [!NOTE] + > When you enter development mode. Some features may be disabled, such as sending statistics, updating data, etc. -## ☕ จำลอง +## ☕ Serve -ทดสอบการใช้งานจริงด้วยการทำงานที่คล้ายกับการใช้งานจริง โดยระบบจะคำนวณการแยกเศษของการทำงานตามจำนวนของกิลด์โดยอัตโนมัติ +Test the actual use by performing tasks similar to real use. The system will automatically calculate the split of the work fraction according to the number of guilds. -- เปิดเทอร์มินัลแล้วรัน `npm run emulators` เพื่อจำลองระบบฐานข้อมูลใน**โหมดจำลอง** -- เปิดเทอร์มินัลหน้าใหม่แล้วรันคำสั่ง `npm run serve` > **💡 หมายเหตุ:** คุณจะเข้าสู่โหมดการพัฒนาโดยอัตโนมัติเนื่องจากเป็นการจำลองการใช้งานจริง ทำให้คุณสมบัติบางอย่างอาจไม่ทำงาน +- Open a terminal and run `npm run emulators` to simulate the database system in **emulation mode**. +- Open a new terminal and run the command `npm run serve`. + > [!NOTE] + > You will automatically enter development mode as this is a production simulation. Cause some features may not work. -## 🍵 ใช้งานจริง +## 🍵 Production -สำหรับการใช้งานจริงสามารถใช้คำสั่งหรือชุดคำสั่งที่เตรียมไว้ได้ตามปกติ ดังนี้: +For actual use, the prepared command or set of commands can be used normally as follows: -- บน Linux หรือ MacOS +- On Linux or MacOS ```sh # with command file (recommend) @@ -134,7 +142,7 @@ npm install --global --production --add-python-to-path windows-build-tools npm start ``` -- บน Windows +- On Windows ```bat @REM with command file (recommend) @@ -146,31 +154,33 @@ npm install --global --production --add-python-to-path windows-build-tools npm start ``` -### 🐳 ทำงานบน Docker +### 🐳 Running on Docker -การดำเนินการนี้จำเป็นต้องมี [Docker](https://www.docker.com/products/docker-desktop/) +This operation requires [Docker](https://www.docker.com/products/docker-desktop/) -- ใช้คำสั่ง `npm run docker:build` แล้วรอให้ทำงานเสร็จทั้งหมด -- จากนั้นเปิดโปรแกรม Docker แล้วสั่งรันพร้อมกับใส่ข้อมูลสภาพแวดล้อมที่จำเป็น (env) หรือใช้คำสั่ง `npm run docker:run` แล้วรอจนบอททำงาน > **💡 หมายเหตุ:** คุณสามารถตรวจสอบการทำงานได้โดยใช้คำสั่ง `docker ps -a` +- Use the command `npm run docker:build` and wait for all the work to complete. +- Then open the Docker program and run it with the required environment information (env) or use the command `npm run docker:run` and wait until the bot is running. + > [!TIP] + > You can check the functionality using the command `docker ps -a`. -## แก้ไขปัญหาอย่างรวดเร็ว +## ⚡ Quick Troubleshooting -### `gyp ERR! stack Error: not found: make` +- `gyp ERR! stack Error: not found: make` -ปัญหานี้อาจเกิดจาก **Build Tools** ติดตั้งไม่ถูกต้องหรืออาจยังไม่ได้ติดตั้ง วิธีแก้ไขปัญหานี้ให้ดูที่ส่วน[การติดตั้ง Build Tools](#1-ติดตั้ง-build-tools) + This problem may be caused by **Build tools** being installed incorrectly or may not have been installed yet. This problem can be solved by looking at the [installation](#1-install-build-tools) section. -### `@firebase/firestore: Firestore (10.6.0): GrpcConnection RPC 'Write' stream 0x58a118ce error. Code: 14 Message: 14 UNAVAILABLE: No connection established. Last error: connect ECONNREFUSED 127.0.0.1:8080` +- `GrpcConnection RPC 'Write' stream 0x58a118ce error. Code: 14 Message: 14 UNAVAILABLE: No connection established. Last error: connect ECONNREFUSED 127.0.0.1:8080` -เป็นไปได้ว่าคุณยังไม่ได้จำลองระบบฐานข้อมูลบนเครื่องในโหมดทดสอบ โดยคุณสามารถแก้ปัญหานี้ได้โดยปิดบอทแล้วรันคำสั่งดังนี้ในอีกหน้าหนึ่ง + It is possible that you have not yet simulated the database system on the machine in test mode. You can solve this problem by closing the bot and running the following command on another page. -```bat -npm run emulators -``` + ```bat + npm run emulators + ``` -## ปรับปรุงการแปลภาษา +## 🌐 Improve Translate You can help us translate existing languages or languages that are not currently available on [Crowdin](https://crowdin.com/project/shioru). -## Found a problem +## ⚠️ Found a problem -หากคุณพบปัญหาใดๆ จากการทำงานปัจจุบันของคุณ คุณสามารถแจ้งให้เราทราบได้ผ่านแท็บ [issues](https://github.com/Maseshi/Shioru/issues) ของพื้นที่เก็บนี้ได้ +If you encounter any problems from your current job You can let us know through the tab. [issue](https://github.com/Maseshi/Shioru/issues) of this repository. diff --git a/documents/README.th.md b/documents/README.th.md index 1b91ea26..beb6c914 100644 --- a/documents/README.th.md +++ b/documents/README.th.md @@ -1,17 +1,15 @@
-

Shioru

+

Shioru

เลขาส่วนตัวใน Discord ที่จะช่วยทำให้กิลด์ของคุณน่าอยู่ยิ่งขึ้น

- - - - - - - - + + + @@ -28,12 +26,13 @@ เลขาส่วนตัวที่ดีที่สุดของคุณจะช่วยให้กิลด์ของคุณดูมีชีวิตชีวามากขึ้น เธอสามารถทำสิ่งต่าง ๆ ได้หลายอย่างซึ่งคุณสามารถดูรายละเอียดข้อมูลของคำสั่งทั้งหมด ได้ง่าย ๆ โดยพิมพ์ `/help`
- - + +
-## คุณสมบัติเด่น +## ✨ คุณสมบัติเด่น - ทำงานบน [Discord.js](https://discord.js.org/) v14 - สามารถปรับแต่งสิ่งที่ต้องการได้หลากหลายรายการ @@ -48,17 +47,17 @@ และคุณสมบัติที่น่าสนใจอื่นๆ อีกมากมาย... -## ข้อกำหนดเบื้องต้น +## 🧩 ข้อกำหนดเบื้องต้น - [Node.js](https://nodejs.org/) v20.6.0 หรือมากกว่า - [Python](https://www.python.org/downloads/) v3.8.0 หรือมากกว่า - [Java](https://www.oracle.com/java/technologies/downloads/) v11.0.0 หรือมากกว่า -- [Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) หรือ[ติดตั้งด้วยตัวเอง](#1-ติดตั้ง-build-tools) - [Firebase Tools](https://firebase.google.com/docs/cli) +- [Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) - [FFmpeg](https://www.ffmpeg.org/download.html) - [Git](https://git-scm.com/downloads) -## การติดตั้ง +## ⌛ การติดตั้ง ### 1. ติดตั้ง **Build Tools** @@ -66,18 +65,20 @@ - สำหรับระบบปฏิบัติการ Linux และ MacOS -```sh -sudo apt update -sudo apt install build-essential -``` + ```sh + sudo apt update + sudo apt install build-essential + ``` - สำหรับระบบปฏิบัติการ Windows + ```sh + npm install --global --production --add-python-to-path windows-build-tools + ``` -```sh -npm install --global --production --add-python-to-path windows-build-tools -``` - -> **💡 ทริป**: คุณสามารถข้ามขั้นตอนนี้ผ่านตัวติดตั้ง Node.js ดังภาพต่อไปนี้ ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/node-js-tools-for-native-modules.png) +> [!TIP] +> คุณสามารถข้ามขั้นตอนนี้โดยการติ๊กตัวเลือก **Automatically install the necessary tools.** ผ่านตัวติดตั้ง Node.js ดังภาพต่อไปนี้ +> +> ![](https://raw.githubusercontent.com/Maseshi/Shioru/main/assets/images/node-js-tools-for-native-modules.png) ### 2. โคลนบอทและติดตั้งส่วนประกอบ @@ -88,7 +89,8 @@ npm install --global --production --add-python-to-path windows-build-tools npm install ``` - ทำการเปลี่ยนชื่อไฟล์ `.env.example` เป็น `.env` แล้วใส่ค่าที่จำเป็นทั้งหมด - > **💡 หมายเหตุ:** คุณสามารถแก้ไขข้อมูลบางอย่างใน **config** ที่ [./source/configs/data.js](../source/configs/data.js) + > [!NOTE] + > คุณสามารถแก้ไขข้อมูลบางอย่างใน **config** ที่ [./source/configs/data.js](../source/configs/data.js) ### 3. ตั้งค่าบอทและเชิญเข้าร่วม @@ -112,7 +114,8 @@ npm install --global --production --add-python-to-path windows-build-tools - เปิดเทอร์มินัลแล้วรัน `npm run emulators` เพื่อจำลองระบบฐานข้อมูลใน**โหมดพัฒนา** - เปิดเทอร์มินัลหน้าใหม่แล้วรันคำสั่ง `npm run dev` - > **💡 หมายเหตุ:** เมื่อคุณเข้าสู่โหมดการพัฒนา คุณลักษณะบางอย่างอาจถูกปิดใช้งาน เช่น การส่งสถิติ การอัปเดตข้อมูล เป็นต้น + > [!NOTE] + > เมื่อคุณเข้าสู่โหมดการพัฒนา คุณลักษณะบางอย่างอาจถูกปิดใช้งาน เช่น การส่งสถิติ การอัปเดตข้อมูล เป็นต้น ## ☕ จำลอง @@ -120,7 +123,8 @@ npm install --global --production --add-python-to-path windows-build-tools - เปิดเทอร์มินัลแล้วรัน `npm run emulators` เพื่อจำลองระบบฐานข้อมูลใน**โหมดจำลอง** - เปิดเทอร์มินัลหน้าใหม่แล้วรันคำสั่ง `npm run serve` - > **💡 หมายเหตุ:** คุณจะเข้าสู่โหมดการพัฒนาโดยอัตโนมัติเนื่องจากเป็นการจำลองการใช้งานจริง ทำให้คุณสมบัติบางอย่างอาจไม่ทำงาน + > [!NOTE] + > คุณจะเข้าสู่โหมดการพัฒนาโดยอัตโนมัติเนื่องจากเป็นการจำลองการใช้งานจริง ทำให้คุณสมบัติบางอย่างอาจไม่ทำงาน ## 🍵 ใช้งานจริง @@ -156,26 +160,27 @@ npm install --global --production --add-python-to-path windows-build-tools - ใช้คำสั่ง `npm run docker:build` แล้วรอให้ทำงานเสร็จทั้งหมด - จากนั้นเปิดโปรแกรม Docker แล้วสั่งรันพร้อมกับใส่ข้อมูลสภาพแวดล้อมที่จำเป็น (env) หรือใช้คำสั่ง `npm run docker:run` แล้วรอจนบอททำงาน - > **💡 หมายเหตุ:** คุณสามารถตรวจสอบการทำงานได้โดยใช้คำสั่ง `docker ps -a` + > [!TIP] + > คุณสามารถตรวจสอบการทำงานได้โดยใช้คำสั่ง `docker ps -a` -## แก้ไขปัญหาอย่างรวดเร็ว +## ⚡ แก้ไขปัญหาอย่างรวดเร็ว -### `gyp ERR! stack Error: not found: make` +- `gyp ERR! stack Error: not found: make` -ปัญหานี้อาจเกิดจาก **Build Tools** ติดตั้งไม่ถูกต้องหรืออาจยังไม่ได้ติดตั้ง วิธีแก้ไขปัญหานี้ให้ดูที่ส่วน[การติดตั้ง Build Tools](#1-ติดตั้ง-build-tools) + ปัญหานี้อาจเกิดจาก **Build Tools** ติดตั้งไม่ถูกต้องหรืออาจยังไม่ได้ติดตั้ง วิธีแก้ไขปัญหานี้ให้ดูที่ส่วน[การติดตั้ง Build Tools](#1-ติดตั้ง-build-tools) -### `@firebase/firestore: Firestore (10.6.0): GrpcConnection RPC 'Write' stream 0x58a118ce error. Code: 14 Message: 14 UNAVAILABLE: No connection established. Last error: connect ECONNREFUSED 127.0.0.1:8080` +- `GrpcConnection RPC 'Write' stream 0x58a118ce error. Code: 14 Message: 14 UNAVAILABLE: No connection established. Last error: connect ECONNREFUSED 127.0.0.1:8080` -เป็นไปได้ว่าคุณยังไม่ได้จำลองระบบฐานข้อมูลบนเครื่องในโหมดทดสอบ โดยคุณสามารถแก้ปัญหานี้ได้โดยปิดบอทแล้วรันคำสั่งดังนี้ในอีกหน้าหนึ่ง + เป็นไปได้ว่าคุณยังไม่ได้จำลองระบบฐานข้อมูลบนเครื่องในโหมดทดสอบ โดยคุณสามารถแก้ปัญหานี้ได้โดยปิดบอทแล้วรันคำสั่งดังนี้ในอีกหน้าหนึ่ง -```bat -npm run emulators -``` + ```bat + npm run emulators + ``` -## ปรับปรุงการแปลภาษา +## 🌐 ปรับปรุงการแปลภาษา คุณสามารถช่วยเราแปลภาษาที่มีอยู่หรือภาษาที่ยังไม่พร้อมใช้งานในขณะนี้ได้ที่ [Crowdin](https://crowdin.com/project/shioru). -## พบปัญหา +## ⚠️ พบปัญหา หากคุณพบปัญหาใดๆ จากการทำงานปัจจุบันของคุณ คุณสามารถแจ้งให้เราทราบได้ผ่านแท็บ [issues](https://github.com/Maseshi/Shioru/issues) ของพื้นที่เก็บนี้ได้