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

Added env.example File for Environment Variable Configuration #475

Merged
merged 2 commits into from
Aug 4, 2024

Conversation

vamshi726
Copy link
Contributor

Summary of Changes:

Added a .env.example file to provide a template for environment variables used in the project.
Included placeholders for Cloudinary credentials, Google OAuth credentials, JWT secret, email settings, MongoDB connection string, React app base URL, and Unsplash API key.

Fixes #474

Type of change

Please mark with an X the type that applies:

  • Documentation update

Motivation and Context

Adding a .env.example file helps new contributors understand the required environment variables and how to configure them for local development. This improves the onboarding process and ensures consistency in environment setups.

How Has This Been Tested?

This change doesn’t require specific tests since it involves adding a sample configuration file.

Test A: Verified that the .env.example file includes all necessary environment variables and provides clear instructions.

Test B: Confirmed that the file format is correct and that placeholders are accurately described.

Screenshots and Videos

No screenshots or videos are applicable for this change.

Checklist

Please mark with an X the items that apply:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Copy link

vercel bot commented Aug 1, 2024

@vamshi726 is attempting to deploy a commit to the vansh69's projects Team on Vercel.

A member of the Team first needs to authorize it.

@hustlerZzZ hustlerZzZ added gssoc This label is attached to the issues related to Gssoc'24 level1 labels Aug 4, 2024
@hustlerZzZ hustlerZzZ merged commit 61d4381 into VanshKing30:main Aug 4, 2024
0 of 2 checks passed
Copy link

github-actions bot commented Aug 4, 2024

Congratulations, Your pull request has been successfully merged 🥳🎉 Thank you for your contribution to the project 🚀 Keep Contributing!! ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
gssoc This label is attached to the issues related to Gssoc'24 level1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Add env.example File for Environment Variable Configuration
2 participants