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

feat: Improve Dev Server Setup & Repository Structure #52

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jjinendra3
Copy link

@jjinendra3 jjinendra3 commented Mar 4, 2025

Description

This PR improves the development setup by making it more beginner-friendly and aligning with standard monorepo practices. Additionally, it optimizes the repository structure by consolidating redundant .gitignore files and adding an .env.example for better clarity.

Issues Closes

#51

Changes Implemented:

Unified frontend & backend dev servers into a single command using concurrently with clear labels (FE & BE) and colors.
Consolidated multiple .gitignore files into a single root-level .gitignore to ensure consistency.
Added an .env.sample file to guide users on setting up environment variables easily.
✅ Updated Project Setup Guide to reflect these improvements.

Benefits:

🚀 Simplifies development: Both frontend & backend run in a single terminal session.
📂 Cleaner repo structure: A single .gitignore instead of multiple scattered ones.
🔍 Better onboarding: .env.sample helps users understand required env variables.
🎨 Improved terminal experience: Labels (FE & BE) with colors for clarity.

Testing:

  • Ran npm run dev, verified both FE & BE start correctly in a single terminal.
  • Checked that the new .gitignore correctly ignores unnecessary files.
  • Ensured .env.example provides clear guidance without exposing actual credentials.

Would love feedback on this! 🚀

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.

1 participant