From 6d7dcd865b89ac687dcd483296d6902de71e8db4 Mon Sep 17 00:00:00 2001 From: Anushka Sarkar Date: Tue, 7 Oct 2025 13:52:49 +0530 Subject: [PATCH] File tree structure added properly --- README.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 51 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 493a2f0..744653b 100644 --- a/README.md +++ b/README.md @@ -135,12 +135,57 @@ Your backend runs at 👉 [http://localhost:5000](http://localhost:5000) ``` DevSync/ -├── frontend/ # Frontend (React + ShadCN UI) -├── backend/ # Backend (Node.js + Express) -├── CONTRIBUTING.md # Contribution guidelines -├── CODE_OF_CONDUCT.md # Community rules -├── LICENSE # MIT License -└── README.md # Project overview +├─ 🗄️ .github/ +│ ├─ 📄 ISSUE_TEMPLATE/ → Issue templates for contributors +│ ├─ ⚙️ scripts/ → GitHub automation scripts (cleanup, validation, etc.) +│ ├─ 🤖 workflows/ → GitHub Actions CI/CD workflows +│ └─ 📑 PULL_REQUEST_TEMPLATE.md → PR submission format +│ +├─ 📸 assets/ +│ ├─ 🖼️ screenshots/ → Setup & API reference images +│ ├─ gssoc.png +│ └─ img1.jpg / img2.jpg / img3.jpg +│ +├─ 💻 backend/ +│ ├─ ⚙️ config/ → Auth & server configuration (e.g., passport.js) +│ ├─ 📝 controllers/ → Handles API logic (e.g., contact.controller.js) +│ ├─ 🗄️ db/ → Database connection setup +│ ├─ 🛡️ middleware/ → Auth & rate-limit middleware +│ ├─ 📦 models/ → MongoDB models (User, ContactMessage, etc.) +│ ├─ 🌐 routes/ → API routes (auth, contact, profile) +│ ├─ 📧 services/ → Email & external services +│ ├─ 🛠️ utils/ → Helper functions (email, cron jobs, etc.) +│ └─ 🚀 server.js → Main backend entry point +│ +├─ 📚 docs/ +│ ├─ 🛠️ setup/ → Integration guides (Google Auth, Resend, Sheets) +│ └─ 📄 env_guide.md → Environment variable documentation +│ +├─ ⚛️ frontend/ +│ ├─ 🌐 public/ → Static assets (e.g., vite.svg) +│ ├─ src/ +│ │ ├─ 🧩 Components/ +│ │ │ ├─ 🔑 auth/ → Login, Register, Forgot Password, etc. +│ │ │ ├─ 📊 DashBoard/ → Dashboard UI components +│ │ │ ├─ 🧭 Navbar/, Footer.jsx, Hero.jsx, About.jsx, etc. +│ │ │ ├─ 🎨 ui/ → Reusable UI elements (buttons, loaders, toggles) +│ │ │ └─ 👤 profile/ → User profile components +│ │ ├─ 🌐 context/ → React Context providers (Timer, Theme) +│ │ ├─ 🛠️ lib/ → Utility scripts & validation schemas +│ │ ├─ 🚪 App.jsx / main.jsx / index.css → React entry files +│ │ └─ 🎨 App.css → Global styles +│ ├─ 📝 index.html → Root HTML +│ ├─ ⚙️ vite.config.js → Vite config +│ ├─ 🔧 eslint.config.js / jsconfig.json → Linting & path configs +│ └─ 🚀 vercel.json → Deployment config +│ +├─ 📚 docs/ → Developer documentation +├─ ❌ .gitignore +├─ 📝 README.md → Project overview +├─ 📜 LICENSE / CODE_OF_CONDUCT.md / CONTRIBUTING.md +├─ 🔧 auth-profile-implementation.md → Feature documentation +└─ 📦 package.json → Dependencies and project metadata + ```