Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEAT]: Addition of .env_sample file in the project #48

Open
vivekrawat21 opened this issue Oct 16, 2024 · 1 comment
Open

[FEAT]: Addition of .env_sample file in the project #48

vivekrawat21 opened this issue Oct 16, 2024 · 1 comment

Comments

@vivekrawat21
Copy link

vivekrawat21 commented Oct 16, 2024

Currently, contributors do not have a reference for required environment variables, which can lead to setup confusion or misconfigurations.
To streamline the development process, we should add an env_sample file that outlines the necessary environment variables without sensitive data. Create an env_sample file in the root of the project
Include placeholders for all required environment variables.
Add documentation in the file explaining what each variable does and any necessary values or formats.
Ensure sensitive data is not included—use placeholders (e.g., YOUR_API_KEY_HERE).
Update the README.md with a section on how to use the env_sample file.

Additional context
Benefits:
Improves onboarding for new contributors.
Prevents setup issues related to missing or incorrect environment variables.

@rupesh-dev30
Copy link

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants