docs: Added docker details in setting-things-up.md

[rajdip-b]

PR Type

Documentation

---

Description

• Removed Docker Compose instructions from running-the-api.md.
• Added detailed Docker Compose setup instructions in setting-things-up.md, including:
  • Steps to start dependencies (PostgreSQL, Redis, Minio) using Docker Compose.
  • Required ports for the services.
  • Troubleshooting tips for PostgreSQL.
  • Instructions for shutting down the Docker infrastructure.

---

Changes walkthrough 📝

Relevant files

Documentation

running-the-api.md Remove Docker Compose instructions for API setup                  docs/contributing-to-keyshade/running-things-locally/running-the-api.md Removed instructions to start database and cache using Docker Compose. +0/-6      setting-things-up.md Add Docker Compose setup instructions for development environment docs/contributing-to-keyshade/setting-things-up.md Added detailed instructions for setting up the development environment using Docker Compose. Included information about required ports and troubleshooting PostgreSQL issues. Added instructions for shutting down the Docker infrastructure. +37/-0

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-free]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No key issues to review

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Enhancement	✅ Correct the typo in the section title Suggestion Impact: The typo in the section title was corrected as suggested. code diff: -## Settng up the development environment +## Setting up the development environment There's a typo in the section title "Settng up the development environment". It should be corrected to "Setting up the development environment" to maintain professionalism and clarity in documentation. docs/contributing-to-keyshade/setting-things-up.md [64] -## Settng up the development environment +## Setting up the development environment Apply this suggestion Suggestion importance[1-10]: 9 Why: The suggestion addresses a clear typo in a section title, which is important for maintaining professionalism and clarity in the documentation.	9
	Correct typos and clarify the description of service exposure The phrase "then expose the services yo your host maching" contains a typo and is somewhat unclear. It would be clearer to say "then expose the services to your host machine". docs/contributing-to-keyshade/setting-things-up.md [72] -This will start the following things in a dockerized environment and then expose the services yo your host maching: +This will start the following things in a dockerized environment and then expose the services to your host machine: Apply this suggestion Suggestion importance[1-10]: 9 Why: The suggestion fixes typos and improves the clarity of the documentation, which enhances readability and comprehension for users.	9
Possible issue	Restore or update the Docker setup instructions for the database and cache It appears that the instructions for starting the database and cache using Docker were removed. If these steps are still necessary for setting up the environment, consider adding them back or providing updated instructions if the setup process has changed. docs/contributing-to-keyshade/running-things-locally/running-the-api.md [6-11] -- Get the database and cache up and running: +- Start the necessary Docker containers for the database and cache: ```bash docker compose up -d - [ ] **Apply this suggestion** <!-- /improve --apply_suggestion=2 --> <details><summary>Suggestion importance[1-10]: 8</summary> Why: The suggestion correctly identifies the removal of important setup instructions for the database and cache. Restoring or updating these instructions is crucial for users to set up their development environment properly. </details></details></td><td align="center">8 </td></tr><tr><td rowspan="1"><strong>Maintainability</strong></td> <td> <details><summary>Improve the readability of the port requirements by using a bulleted list with descriptions</summary> ___ **To enhance the clarity and readability of the documentation, consider using a <br/>bulleted list for the ports that need to be free. This format can make it easier for <br/>users to quickly scan through the required information.** [docs/contributing-to-keyshade/setting-things-up.md [80-83]](https://github.com/keyshade-xyz/keyshade/pull/358/files#diff-cef348a8823f15a58b87562625cba74999f427c52980164863ee234f45897d44R80-R83) ```diff -- 5432 -- 6379 -- 9000 -- 9001 +- PostgreSQL (5432) +- Redis (6379) +- Minio (9000) +- Minio Console (9001) Apply this suggestion Suggestion importance[1-10]: 7 Why: The suggestion improves the readability of the port requirements by providing descriptions, which can help users quickly understand the necessary information. However, it is a minor enhancement.	7