Skip to content

Add interactive environment setup script (npm run setup)#25

Open
Codewithpabitra wants to merge 1 commit intoZenYukti:mainfrom
Codewithpabitra:envScripts
Open

Add interactive environment setup script (npm run setup)#25
Codewithpabitra wants to merge 1 commit intoZenYukti:mainfrom
Codewithpabitra:envScripts

Conversation

@Codewithpabitra
Copy link

Description

Adds an interactive environment setup script to simplify initial project configuration. Users can now run npm run setup to generate backend/.env and frontend/.env from existing .env.example files by providing required credentials.

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • 🧹 Code refactoring (no functional changes)
  • ⚡ Performance improvement
  • ✅ Test improvement
  • 🔧 Build or CI/CD configuration changes

How Has This Been Tested?

  • Ran npm run setup locally on Windows
  • Verified .env files are generated correctly for both frontend and backend
  • Confirmed project runs successfully using npm run dev

Screenshots

N/A (CLI-based change)

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own 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
  • Any dependent changes have been merged and published in downstream modules

Additional Information

  • This change improves onboarding and reduces setup friction, especially for Windows users where manual .env copying can be error-prone.

Learning Outcomes

  • Learned how to build a cross-platform interactive CLI script for environment setup using Node.js.

Let me know if any further improvement is needed on this issue. Thank you !

@github-actions
Copy link

github-actions bot commented Feb 6, 2026

ZenYukti Banner

Yay! You're officially a Contributor! 🎉

Huge thanks for opening this Pull Request. Being a contributor to ZenYukti is a big deal, and we’re excited to have you on board.

Next Steps:

  1. A maintainer will review your code soon.
  2. Please ensure you've linked an assigned issue in the description.
  3. Stay tuned for feedback!

@Codewithpabitra
Copy link
Author

@ayushHardeniya If you tell I can Update the documentation as well. Let me know if further work is required on this issue .
Thank you!

@ayushHardeniya ayushHardeniya linked an issue Feb 6, 2026 that may be closed by this pull request
@ayushHardeniya
Copy link
Member

Hi, thank you for the contribution - we appreciate your effort.

Just a small request: please avoid tagging maintainers imediately after opening an issue or PR.
We review items in the queue, nd response times can vary depending on availability. If there’s no update after about 24 hours, you’re welcome to post a gentle reminder.

Thanks for your patience and for contributing to the project.

@Codewithpabitra
Copy link
Author

Okay, didn't aware of, Thank u!

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.

make setup easier with an interactive script

2 participants