auth-bot

commit 00d52e829f7da7386d453f1d847b91fb5bf3c998
parent cf119c16e084abc47dbbe3b7f3c816f871634be2
Author: hcs1219 <[email protected]>
Date:   Sat, 27 Apr 2024 23:18:36 +0800

Update README.md
Diffstat:
M
README.md
 | 
62
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++-----

1 file changed, 57 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
@@ -1,20 +1,72 @@
 # Auth
 
 Auth is a Discord Bot to verify user, giving server owner the ability to pull back members in case of deletetion or forgot login.
-## Getting Started
 
-To get started with the project, simply clone the repository and install the dependencies
+# Getting Start
 
+### 1. Create a bot and copy TOKEN, CLIENT ID and CLIENT SECRET in [Discord Developer Portal](https://discord.com/developers/applications) (Bot Tab)
+![Discord Token](https://cdn.discordapp.com/attachments/837865823225511946/1233736241376137216/getting_start_token.png?ex=662e2de9&is=662cdc69&hm=a1199ad3f800c61f5b6686a6279e93962db3046bd78e194d1643cbeafcf1c6df)
+![Discord Client](https://cdn.discordapp.com/attachments/837865823225511946/1233736241040850984/getting_start_client.png?ex=662e2de9&is=662cdc69&hm=31b6679d650abf2706fd9c1994e8844a91904c13cf33bfee527796ff105ee027)
+### 2. Enable Intents as below
+![Discord Intents](https://cdn.discordapp.com/attachments/837865823225511946/1233734791698972702/getting_start_intents.png?ex=662e2c90&is=662cdb10&hm=aa39490e9a2488806e8c809e207384b37207aaa6047367e436b5c89409cda19b)
+### 3. Set the permissions as below (OAuth2 Tab)
+Tick these boxes in SCOPES:
+- bot
+- applications.commands
+
+Tick these boxes in BOT PERMISSIONS:
+- Manage Server
+- Manage Roles
+- Manage Channels
+- Create Instant Invite
+- Read Messages/View Channels
+- Send Messages
+- Manage Messages
+- Read Message History
+
+Then, use the Link below to invite your bot to Servers.
+### 4. Create a Database in [MongoDB](https://mongodb.com)
+Go to Overview > Data Services > Connect > Drivers.
+Copy the code in Step 3\
+![Mongo](https://cdn.discordapp.com/attachments/837865823225511946/1233734792621723738/getting_start_mongo.png?ex=662e2c90&is=662cdb10&hm=27b9e02e2b8268d551010f0ed67536c74b49f012ca4c2ee330f6f7e591e6b7d2)
+### 5. Choose the host you are using
+- [Replit](#Replit)
+- [Other Host](#Other-Host)
+
+## Replit
+### 6. Create a new project by importing from github
+![Replit Import](https://cdn.discordapp.com/attachments/837865823225511946/1233748914897686528/getting_start_import.png?ex=662e39b7&is=662ce837&hm=1823173d343f2d963a312398f099f21e4413a68aea718e8c6cd63c029e80577d)
+### 7. Add the information below in Secrets
+![Replit Secret](https://cdn.discordapp.com/attachments/837865823225511946/1233737177112772608/getting_start_replit_secret.png?ex=662e2ec8&is=662cdd48&hm=7d4b9f1d678b89bfc37cb1f865c270919710e5fec590a75930948f0df420710f)
+
+## Other Host
+### 6. Clone the repository and install the dependencies
 ```cmd
-git clone https://github.com/night0721/Auth.git
-cd Auth
+git clone https://github.com/night0721/auth-bot.git
+cd auth-bot
 npm i
+```
+### 7. Create a .env file and paste the code below, and replace XXX with a valid value 
+```Dotenv
+TOKEN=XXX
+CLIENT_ID=XXX
+CLIENT_SECRET=XXX
+MONGO=mongodb+srv://XXX
+CALLBACK_URL=http://XXX.XXX/api/auth/discord/redirect
+PORT=XXX
+api=https://api.night0721.xyz
+```
+![Dotenv File](https://cdn.discordapp.com/attachments/837865823225511946/1233738177693352017/getting_start_dotenv.png?ex=662e2fb7&is=662cde37&hm=f62ef3ed8f6920da5acba8bebe6e1e0388def9b1623ffcf573455bc1011d5533)
+
+### 8. Run the server, and now enjoy!
+```cmd
 npm run dev
 ```
+Join our Discord Server for update's news!
 
 ## Support
 
-If you need support, you can join the [Discord server](https://discord.gg/SbQHChmGcp)
+If you need support, you can join the [Discord Server](https://discord.gg/SbQHChmGcp)
 
 ## License