Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 51 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

```


Expand Down
Loading