Skip to content

README.md

Latest commit

 

History

History
165 lines (138 loc) · 4.64 KB

README.md

File metadata and controls

165 lines (138 loc) · 4.64 KB

🚀 Greedy Todo Backend - Real-Time API

Node.js Express TypeScript MongoDB Socket.io Passport.js

A full-stack backend with real-time features and smart authentication

Built this to learn real-time systems and modern auth patterns. Every feature was designed to solve real problems, not just follow tutorials.

🏗️ Key Features

1. Triple Authentication System

// Smart auth handling
authProvider: "local" | "google" | "guest"

What I Built:

  • JWT tokens with different expiry times
  • Google OAuth integration with user merging
  • Guest users with 24-hour sessions
  • Role switching (normaluser ↔ superuser)

2. Real-Time Notifications

// Smart deadline detection
export const startNotificationJob = (io: Server) => {
  setInterval(async () => {
    for (const [socketId, socket] of io.sockets.sockets) {
      const userId = socket.data.userId;
      const userTasks = await getUserTasksStatus(userId);
      socket.emit("getNotification", userTasks);
    }
  }, 10000);
};

Real-Time Features:

  • 4-hour deadline warnings sent automatically
  • Live role updates across all devices
  • User-specific notifications via WebSocket
  • Connection tracking with user IDs

3. Smart Data Models

// Conditional validation
password: {
  type: String,
  required: function (this: IUser) {
    return !this.googleId && !this.isGuest;
  },
  minlength: 8,
}

Database Design:

  • Flexible user types (local, Google, guest)
  • Automatic timestamps and updates
  • User-scoped data (users only see their tasks)
  • Efficient queries with lean operations

🚀 API Endpoints

Authentication

POST /api/auth/register          # User registration
POST /api/auth/login             # Local login
POST /api/auth/guest-login       # Guest session
GET  /api/auth/google            # Google OAuth

Tasks

GET    /api/task                 # Get user's tasks
POST   /api/task                 # Create task
PUT    /api/task/:id             # Update task
DELETE /api/task/:id             # Delete task

Users

GET  /api/user                   # Get all users
PUT  /api/user/profile           # Update profile
PUT  /api/user/role/:id          # Change role

🎓 What I Learned

Real-Time Systems

  • WebSocket connections and user tracking
  • Event-driven notifications for deadlines
  • Connection management and reconnection logic
  • Smart polling instead of constant checking

Authentication

  • Multi-provider auth (Local, Google, Guest)
  • JWT token management with different expiry times
  • Role-based access and permission handling
  • Guest user lifecycle with automatic cleanup

Database Design

  • MongoDB schemas with TypeScript
  • Conditional validation based on user types
  • User-scoped data for security
  • Efficient queries with lean operations

API Architecture

  • RESTful design with proper status codes
  • Error handling and validation
  • Middleware patterns for auth
  • Modular structure for maintainability

🚀 Quick Start

# Clone and install
git clone https://github.com/yourusername/greedy-todo-backend.git
cd greedy-todo-backend
npm install

# Set up environment
cp .env.example .env
# Add your MongoDB URI, JWT secret, and Google OAuth credentials

# Start development
npm run dev

Environment Variables

MONGODB_URI=your_mongodb_connection_string
JWT_SECRET=your_jwt_secret_key
GOOGLE_CLIENT_ID=your_google_client_id
GOOGLE_CLIENT_SECRET=your_google_client_secret
FRONTEND_URL=http://localhost:3000
PORT=8000

🏗️ Project Structure

src/
├── config/          # Passport.js setup
├── controllers/     # Business logic
├── middleware/      # Auth & validation
├── models/          # MongoDB schemas
├── routes/          # API endpoints
└── utils/           # Notification system

Built by Vaishnavi Rastogi as a learning project

GitHub • LinkedIn