feat: Improve Dev Server Setup & Repository Structure #52
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.
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:
npm run dev
, verified both FE & BE start correctly in a single terminal..gitignore
correctly ignores unnecessary files..env.example
provides clear guidance without exposing actual credentials.Would love feedback on this! 🚀