How rnagatarun/devsync works
Project type and purpose
• This is a full-stack web application named DevSync
• Frontend: React + Vite + TypeScript + Tailwind CSS + DaisyUI + react-router-dom + axios
• Backend (“services” folder): Node.js + Express + TypeScript + a database layer (via services/src/database.ts)
• Purpose: allow users to register/login, view and manage profiles and “connection requests”
File structure
• Top-level:
– public, index.html, src/ (React app), tailwind.config.js, vite.config.ts, tsconfig*.json
– services/: a standalone Node/Express API with its own package.json, tsconfig, src/
• services/src:
– app.ts (Express app setup)
– database.ts (DB connection logic)
– middlewares/auth.ts (auth guard)
– models/ (ORM/types for User and ConnectionRequest)
– routes/ (auth, profile, request, user endpoints)
– utils/validation.ts (input validation)
How to represent this
a. Main components
1. User’s Browser / React SPA
2. HTTP Client Module in React (axios)
3. Express API Server
4. Database (e.g. PostgreSQL/MongoDB)
5. Authentication & Validation (middleware)
b. Relationships & data flow
– Browser ↔ Frontend Router (react-router-dom)
– React Components → axios HTTP calls → API Server endpoints
– Express middleware chain: request → auth/validation → route handler
– Route handler → models → database queries → response
c. Architectural patterns & design principles
– Frontend: Single Page Application, Component-based UI, client-side routing
– Backend: MVC-like separation (routes/controllers vs. models vs. middleware)
– Typed contract between layers via TypeScript interfaces/types
– Shared validation logic in utils, centralized error handling in middleware
d. Key technologies
– Frontend: Vite, React, TypeScript, Tailwind CSS, DaisyUI, react-router-dom, axios
– Backend: Node.js, Express, TypeScript, ts-node, database driver/ORM, middleware for auth
– Build/deploy: npm scripts, tsconfig configurations, environment variables
Step-by-step
– Top: Middlewares (auth.ts, validation.ts)
– Middle: Routes/controllers (auth.ts, profile.ts, request.ts, user.ts)
– Bottom: Models (connectionRequest.ts, user.ts) and DB connection (database.ts)