enhance README with detailed setup and add .env.example#61
Open
iamkrshivam wants to merge 2 commits into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the project documentation and configuration setup:
.env.example– Provides a template for all required environment variables (e.g.,PORT,MONGO_URL,SESSION_SECRET), making it easier for new users to configure the application.Changes
readme.md– Restructured, added badges, clarified installation steps (Yarn), included an “Environment Variables” section referencing.env.example, and improved formatting..env.example– New file with placeholder values and comments for every configuration variable used by the app.Testing
.env.exampleto.env, filled in local values.npm installandgulp– the application started successfully.Related Issues
Closes #32 (if that issue is about outdated setup instructions – adjust as needed).
Helps with contributor onboarding and environment configuration.