🚀 PrimeTrade Assignment

A full-stack Task Management Application featuring a scalable REST API with JWT Authentication, Role-Based Access Control (RBAC), and a modern Next.js frontend.

Repository: https://github.com/skg58/primetrade-assignment

---

📋 Table of Contents

• Architecture Overview
• Tech Stack
• Getting Started
• Backend Setup
• Frontend Setup
• API Documentation
• Project Structure
• Features
• Environment Variables

---

🏗️ Architecture Overview

┌──────────────┐        ┌──────────────┐        ┌──────────────┐
│   Next.js    │  HTTP  │   Express    │  Query  │   MongoDB    │
│   Frontend   │◄──────►│   Backend    │◄──────►│   Database   │
│  (Port 3000) │  REST  │  (Port 8000) │  ODM   │  (Port 27017)│
└──────────────┘        └──────────────┘        └──────────────┘
     │                        │
     │ TailwindCSS            │ JWT / bcrypt / Zod
     │ React Context          │ Helmet / CORS / Rate Limit

---

🛠️ Tech Stack

Backend

Technology	Purpose
Node.js + Express.js	Server & API framework
TypeScript	Type safety
MongoDB + Mongoose	Database & ODM
JWT (jsonwebtoken)	Authentication tokens
bcrypt	Password hashing
Zod	Request validation
Helmet + CORS + Rate Limiter	API security

Frontend

Technology	Purpose
Next.js 14 (App Router)	React framework
TypeScript	Type safety
TailwindCSS	Utility-first styling
Axios	HTTP client
React Hot Toast	Notifications
Lucide React	Icons

---

🚀 Getting Started

Prerequisites

• Node.js >= 18.x
• MongoDB >= 6.x (running locally or MongoDB Atlas)
• npm >= 9.x

Clone the Repository

git clone https://github.com/skg58/primetrade-assignment.git
cd primetrade-assignment

---

⚙️ Backend Setup

# Navigate to backend
cd backend

# Install dependencies
npm install

# Configure environment (edit .env as needed)
# The .env file is pre-configured for local development

# Start development server
npm run dev

The backend will start on http://localhost:8000

Build for Production

npm run build
npm start

---

🎨 Frontend Setup

# Navigate to frontend (from project root)
cd frontend

# Install dependencies
npm install

# Start development server
npm run dev

The frontend will start on http://localhost:3000

Build for Production

npm run build
npm start

---

📡 API Documentation

Base URL: http://localhost:8000/api/v1

Authentication Endpoints

Method	Endpoint	Description	Auth Required
POST	/auth/register	Register new user	❌
POST	/auth/login	Login & get JWT	❌
POST	/auth/logout	Logout & clear cookie	✅
GET	/auth/me	Get current user profile	✅

Task Endpoints

Method	Endpoint	Description	Auth Required
POST	/tasks	Create a new task	✅
GET	/tasks	Get all tasks (paginated)	✅
GET	/tasks/:id	Get task by ID	✅
PUT	/tasks/:id	Update a task	✅
DELETE	/tasks/:id	Delete a task	✅

Query Parameters (GET /tasks)

Parameter	Type	Default	Options
page	number	1	Any positive integer
limit	number	10	1-50
status	string	—	todo, in_progress, done
priority	string	—	low, medium, high
search	string	—	Free text search
sortBy	string	createdAt	createdAt, title, status, priority, dueDate
sortOrder	string	desc	asc, desc

Full OpenAPI 3.0 specification available in backend/swagger.yaml

---

📁 Project Structure

primetrade-assignment/
├── backend/                    # Express.js REST API
│   ├── src/
│   │   ├── controllers/        # Route handlers
│   │   ├── database/           # MongoDB connection
│   │   ├── middleware/         # Auth, RBAC, validation, error handling
│   │   ├── models/             # Mongoose schemas
│   │   ├── routes/             # Express routers
│   │   ├── type/               # TypeScript interfaces
│   │   ├── utils/              # Helpers (ApiError, ApiResponse, etc.)
│   │   ├── app.ts              # Express configuration
│   │   ├── constants.ts        # App-wide constants
│   │   └── index.ts            # Server entry point
│   ├── .env                    # Environment variables
│   ├── package.json
│   ├── swagger.yaml            # API documentation
│   └── tsconfig.json
│
├── frontend/                   # Next.js Application
│   ├── src/
│   │   ├── app/                # App Router pages
│   │   │   ├── (auth)/         # Login & Register pages
│   │   │   └── dashboard/      # Protected dashboard pages
│   │   ├── components/         # Reusable UI components
│   │   │   ├── layout/         # Sidebar, Header, DashboardLayout
│   │   │   ├── tasks/          # TaskCard, TaskForm, TaskList, TaskFilters
│   │   │   └── ui/             # Button, Input, Modal, Badge, etc.
│   │   ├── context/            # React AuthContext
│   │   ├── lib/                # Axios instance, auth helpers
│   │   └── types/              # TypeScript interfaces
│   ├── .env.local
│   ├── package.json
│   └── tailwind.config.ts
│
├── README.md                   # This file
└── SCALABILITY.md              # Scalability architecture notes

---

✨ Features

Backend

• ✅ RESTful API with versioning (/api/v1/)
• ✅ JWT Authentication (Bearer token + httpOnly cookies)
• ✅ Role-Based Access Control (User & Admin roles)
• ✅ Zod input validation
• ✅ bcrypt password hashing (10 salt rounds)
• ✅ Standardized API responses (ApiResponse / ApiError)
• ✅ Global error handling middleware
• ✅ Pagination, search, filtering, and sorting
• ✅ Rate limiting & security headers (Helmet)
• ✅ MongoDB compound indexes for performance

Frontend

• ✅ Modern dark UI with glassmorphism effects
• ✅ Responsive design (mobile + desktop)
• ✅ Auth context with persistent sessions
• ✅ Protected routes with auth gate
• ✅ Full CRUD operations for tasks
• ✅ Real-time search with debouncing
• ✅ Toast notifications for API feedback
• ✅ Animated dashboard with stat cards
• ✅ Collapsible sidebar navigation

---

🔐 Environment Variables

Backend (.env)

Variable	Default	Description
PORT	8000	Server port
MONGODB_URI	mongodb://127.0.0.1:27017/primetrade_db	MongoDB connection
JWT_SECRET	—	JWT signing secret
JWT_EXPIRES_IN	7d	Token expiration
CORS_ORIGIN	http://localhost:3000	Allowed CORS origin
NODE_ENV	development	Environment

Frontend (.env.local)

Variable	Default	Description
NEXT_PUBLIC_API_URL	http://localhost:8000/api/v1	Backend API URL

---

📜 License

ISC

---

Built with ❤️ for the PrimeTrade Backend Developer Intern Assignment.