Doc: update the envfile

[satyampsoni]

💭 Description

New developers onboarding the project may face challenges configuring environment variables, especially if these details are not clearly documented. To streamline the setup process, we propose adding a .env file template to the repository.

Proposed Solution

• Create a .env.example file in the root of the project.
• Include all necessary environment variables required to run the application.
• Add comments for each variable, explaining its purpose and possible values.
• Use placeholder values (e.g., YOUR_API_KEY, localhost, etc.) that do not expose sensitive information.
• Update the documentation to include a step explaining how to copy the template and set up the .env file.

Benefits

• Simplifies onboarding for new contributors.
• Reduces setup time and errors due to missing or misconfigured environment variables.
• Promotes best practices by encouraging the use of .env files for configuration.

Tasks

• Create the .env.example file.
• Populate it with placeholders for all required variables.
• Update relevant sections of the documentation.

Additional Context

If there are any existing environment variables or configurations that need to be included, please share them in the comments.

👀 Have you spent some time to check if this issue has been raised before?

• I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

• I have read the Code of Conduct