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

[Feature Request]: Addition of .env_sample file in server #113

Closed
6 tasks done
vivekrawat21 opened this issue Oct 15, 2024 · 3 comments · Fixed by #118
Closed
6 tasks done

[Feature Request]: Addition of .env_sample file in server #113

vivekrawat21 opened this issue Oct 15, 2024 · 3 comments · Fixed by #118
Assignees
Labels
gssoc-ext Extended contribution for GSSoC hacktoberfest Open-source contribution during October for GSSoC hacktoberfest-accepted Eligible contribution for Hacktoberfest rewards level1 Beginner-level contribution or task

Comments

@vivekrawat21
Copy link
Contributor

Is there an existing feature request for this?

  • I have searched the existing feature requests

Describe the feature you would like to request

Currently, contributors do not have a reference for required environment variables, which can lead to setup confusion or misconfigurations. I want to add a .env_sample file in server

What problem does this feature solve?

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 server folder.
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.

Alternative solutions

No response

Confirmation

  • I have read the Bitbox Contributing Guidelines
  • I am a GSSOC-EXT contributor
  • I am a HACKTOBERFEST contributor
  • I have starred the Bitbox repository
  • I would like to help implement this feature
@vivekrawat21 vivekrawat21 added the enhancement New feature or request label Oct 15, 2024
Copy link

👋 Thank you @vivekrawat21 for raising an issue! We appreciate your effort in helping us improve. Our team will review it shortly. Stay tuned!

@Anuj3553 Anuj3553 added gssoc-ext Extended contribution for GSSoC hacktoberfest-accepted Eligible contribution for Hacktoberfest rewards level1 Beginner-level contribution or task hacktoberfest Open-source contribution during October for GSSoC and removed enhancement New feature or request labels Oct 15, 2024
@Anuj3553
Copy link
Collaborator

Hyy @vivekrawat21, I'm assigning this issue to you.

Copy link

Hello @vivekrawat21! Your issue #113 has been closed. Thank you for your contribution!🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gssoc-ext Extended contribution for GSSoC hacktoberfest Open-source contribution during October for GSSoC hacktoberfest-accepted Eligible contribution for Hacktoberfest rewards level1 Beginner-level contribution or task
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants