Skip to content

docs: add .env.example and document environment configuration#750

Open
manshusainishab wants to merge 8 commits intoOWASP:mainfrom
manshusainishab:feature/add-env-example
Open

docs: add .env.example and document environment configuration#750
manshusainishab wants to merge 8 commits intoOWASP:mainfrom
manshusainishab:feature/add-env-example

Conversation

@manshusainishab
Copy link
Contributor

Closes #749

Summary

Adds .env.example and updates README to document environment configuration.

Changes

  • Added .env.example with placeholders for all supported environment variables
  • Updated README with setup instructions
  • Categorized variables for clarity

Why

Improves onboarding and follows standard open-source configuration practices.

Testing

No runtime logic changed. Documentation-only improvement.

@manshusainishab
Copy link
Contributor Author

@northdpole if this feels a improved onboarding experience please review. I am throughly reviewing the onboarding process as you mentioned in
Repository Health Analysis Report: OWASP/OpenCRE
First Time contributor no. is 0 which is severely high and I feel one of the reasons is the onboarding experience of NEW CONTRIBUTORS as they are just starting their open source journey.

@manshusainishab
Copy link
Contributor Author

@northdpole is this feels a improvement or should we just close the PR.

@northdpole
Copy link
Collaborator

this is a good idea, let's also add the ability to load the dotenv when we run the service at least locally

@manshusainishab
Copy link
Contributor Author

hey @northdpole,
done with changes and also will let you know about the module B pre-experiment

@manshusainishab
Copy link
Contributor Author

@northdpole updated the branch ready for the review

@manshusainishab
Copy link
Contributor Author

hey, @northdpole its a quick reminder to please review or if any further changes required I am happy to make them.

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

Successfully merging this pull request may close these issues.

Add .env.example and document environment configuration

2 participants