https://github.com/mutahir-riaz/twitter

Backend for a Twitter clone built with Node.js, featuring API routes for user, tweet, and comment management. Implements JWT for secure authentication, role-based access control, and real-time chat with Socket.io. Includes schemas for users, tweets, and comments. Nodemailer handles email verification and OTP-based password resets.
https://github.com/mutahir-riaz/twitter

cloudinary expressjs jwt-authentication mongodb multer nodejs otp-verification socket-io

Last synced: 3 months ago
JSON representation

Backend for a Twitter clone built with Node.js, featuring API routes for user, tweet, and comment management. Implements JWT for secure authentication, role-based access control, and real-time chat with Socket.io. Includes schemas for users, tweets, and comments. Nodemailer handles email verification and OTP-based password resets.

• Host: GitHub
• URL: https://github.com/mutahir-riaz/twitter
• Owner: mutahir-riaz
• Created: 2024-08-11T05:15:26.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-11T06:07:13.000Z (almost 2 years ago)
• Last Synced: 2025-04-10T17:00:41.977Z (about 1 year ago)
• Topics: cloudinary, expressjs, jwt-authentication, mongodb, multer, nodejs, otp-verification, socket-io
• Language: JavaScript
• Homepage:
• Size: 46.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          

# Twitter Clone Backend

This backend application is the server-side component of a Twitter clone, built using Node.js and Express.js. It handles various functionalities that mirror the core features of Twitter, with a focus on scalability, security, and real-time communication.

## Key Features

### API Routes

- **User Management:** 

  - User registration, login, profile management, following/unfollowing users, and retrieving user timelines.

- **Tweet Management:**

  - CRUD operations for tweets: create, read, update, delete, like, and retweet.

- **Comments and Likes:**

  - Add comments to tweets, like comments, and view comment threads.

- **Search and Hashtags:**

  - Search functionality for users, tweets, and hashtags.

### Schemas

- **User Schema:**

  - Stores user information: username, email, password, bio, profile picture, followers, and following lists.

- **Tweet Schema:**

  - Manages tweet content, author, timestamps, comments, and likes references.

- **Comment Schema:**

  - Handles comment content, linking them to both the tweet and the author.

### Authentication & Authorization

- **JWT Authentication:**

  - Secures API endpoints with JWT tokens, ensuring only authenticated users can access protected routes.

- **Role-Based Access Control:**

  - Restricts access to certain routes based on user roles (e.g., admin, user).

### Email Sending with Nodemailer

- **Email Verification:**

  - Sends a verification email to new users during registration to confirm their email addresses.

- **Password Reset:**

  - Implements an OTP (One-Time Password) system for password resets, where users receive an OTP via email to verify their identity before resetting their password.

### Real-Time Chat with Socket.io

- **Direct Messaging:**

  - Enables real-time direct messaging between users using Socket.io for seamless communication.

- **Notifications:**

  - Real-time notifications for mentions, replies, and messages, enhancing user engagement.

### OTP for Password Reset

- **Secure OTP Generation:**

  - Generates secure, time-limited OTPs for password reset functionality.

- **Verification Process:**

  - Users receive an OTP via email, which they must enter to proceed with resetting their password, ensuring enhanced security.

## Tech Stack

- **Node.js & Express.js:** For building the server and API routes.

- **MongoDB & Mongoose:** For database management and schema definitions.

- **JWT:** For handling authentication and securing API endpoints.

- **Socket.io:** For enabling real-time communication between users.

- **Nodemailer:** For sending emails, including OTPs and verification emails.

- **BCrypt:** For securely hashing and storing user passwords.

This backend is optimized for performance and designed to handle a large number of concurrent users while maintaining the integrity and security of user data. It lays the foundation for a full-featured Twitter clone, providing robust API endpoints and real-time features essential for a social media platform.