docs: Update docs

Author: tjtanjin

README.md

@@ -67,11 +67,7 @@ Python
 // todo: the team will be expanded once members are confirmed
 
 ### Contributing
-If you are looking to contribute to the project, you may find the [**Developer Guide**](https://github.com/react-chatbotify/discord-bot/blob/main/docs/DeveloperGuide.md) useful.
-
-In general, the forking workflow is encouraged and you may open a pull request with clear descriptions on the changes and what they are intended to do (enhancement, bug fixes etc). Alternatively, you may simply raise bugs or suggestions by opening an [**issue**](https://github.com/react-chatbotify/discord-bot/issues) or raising it up on [**discord**](https://discord.gg/6R4DK4G5Zh).
-
-Note: Templates have been created for pull requests and issues to guide you in the process.
+If you are looking to contribute to the project, please refer to the [**Contributing Guide**](https://github.com/React-ChatBotify/discord-bot/blob/main/CONTRIBUTING.md).
 
 ### Support
 If there are any questions pertaining to the application itself (usage or implementation wise), you may create an [**issue**](https://github.com/react-chatbotify/discord-bot/issues), raise it up on [**discord**](https://discord.gg/6R4DK4G5Zh), or drop an email to: **cjtanjin@gmail.com.**

docs/DeveloperGuide.md

@@ -36,7 +36,41 @@ Before diving into the rest of the contents in our developer guide, the followin
 
 ## Setup
 
-Setting up the project is relatively simple. Before you begin, ensure that you have **at least Python 3.10 and Docker** installed.
+Setting up the project can be a little involved if this is your first time (mostly because you have to create a **discord bot**). To begin, head over to the [**discord developer portal**]() and create a new bot. Then, visit the **installation** tab on the left and ensure the following default permissions are given to the bot:
+<details> <summary>Click to view permissions</summary>
+    - Add Reactions
+    - Attach Files
+    - Ban Members
+    - Create Events
+    - Create Polls
+    - Create Private Threads
+    - Create Public Threads
+    - Embed Links
+    - Kick Members
+    - Manage Channels
+    - Manage Events
+    - Manage Messages
+    - Manage Roles
+    - Manage Threads
+    - Mention Everyone
+    - Moderate Members
+    - Read Message History
+    - Send Messages
+    - Send Messages in Threads
+    - Use External Emojis
+    - Use External Stickers
+    - Use Slash Commands
+    - View Audit Log
+    - View Channels
+    - View Server Insights
+    - View Server Subscription Insights
+<details>
+
+Within the **bot** tab, ensure that **presence intent**, **server members intent** and **message content intent** are all enabled. These should be sufficient to create the required discord bot.
+
+Next, we need to setup the discord development server (this is where you'll invite the bot and do all your testing/debugging). Thankfully, the server templates feature makes this step a lot easier. Simply use the [**template provided here**](https://discord.new/UWFcwJYa45bX) to create a discord server for testing your bot. Once that's done, you may proceed to the repository setup.
+
+To setup the project repository proper, ensure that you have **at least Python 3.10 and Docker** installed.
 1) Fork the [project repository](https://github.com/react-chatbotify/discord-bot).
 2) Clone the **forked project** into your desired directory with:
     ```
@@ -46,7 +80,8 @@ Setting up the project is relatively simple. Before you begin, ensure that you h
     ```
     pip install -r requirements.txt -r requirements-dev.txt
     ```
-4) Once installations are complete, you may launch the project with:
+4) Populate the *.env.local* file with the necessary values (e.g. bot token, channel ids)
+5) Once installations are complete and your env file is setup, you may launch the project with:
     ```
     hatch run start
     ```

pyproject.toml

@@ -16,7 +16,7 @@ packages = ["src/bot"]
 [tool.hatch.envs.default.scripts]
 lint = "darglint ./src/bot && ruff check --fix ./src/bot && black --check ./src/bot"
 format = "ruff check --fix ./src/bot && black ./src/bot"
-start = "docker compose up -d --build"
+start = "docker compose --env-file .env.local up -d --build"
 
 [tool.hatch.envs.dev]
 dependencies = ["pre-commit"]