Skip to content

README.md

Latest commit

 

History

History
70 lines (58 loc) · 3.48 KB

README.md

File metadata and controls

70 lines (58 loc) · 3.48 KB

📱 Text Feed API

Modular NestJS backend for a social feed system with organized architecture and security features.

Note

This project is a Learning Project. Some features may be overkill or included only for practice (e.g., Redis, extra security layers, or more complex patterns).

🚀 Tech Stack & Architecture

  • TypeORM — ORM for Entities, Relations, and Migrations.
  • PostgreSQL — Relational database for structured, linked data.
  • Redis (Caching) — In-memory layer to speed up repeated queries.
  • Indexing & Unique Indexes — Improves read performance and prevents duplicates.
  • Rate Limiting (Throttler) — Prevents excessive requests and abuse.
  • Recaptcha Validation (v3) — Blocks bot activity on sensitive endpoints.
  • Normalization — Ensures clean input and consistent database structure.
  • Modular Architecture — Each feature is isolated into its own NestJS module.

📦 Features

  • Authentication — Secure login and signup workflow using JWT tokens and opaque tokens.
  • Access & Refresh Tokens — Short-lived access tokens and long-lived refresh tokens for session continuity.
  • Partial User Search — Search for users by matching parts of their username.
  • Public User Data — Exposes non-sensitive profile information.
  • Posts — Create, view, and manage user-generated posts.
  • Comments — Commenting system with parent–child relations(self referencing).
  • Follow System — Basic social graph to follow/unfollow users.
  • Like System (Posts/Comments) — Unique like actions enforced with unique indexes.
  • Identicon Avatars/PFPs — Auto-generated profile images for new users.
  • Rate Limiting — App-wide throttling to prevent request flooding.
  • Helmet Protection — Adds secure HTTP headers for baseline protection.
  • GZip Compression — Reduces response size for faster delivery.
  • Swagger Docs — Auto-generated API documentation.
  • Recaptcha (v3) — Server-side validation to block automated signups/logins.
  • Cursor-Based Pagination — Efficient, scalable feed pagination.
  • Role-Based Access Control (RBAC) — Restricts actions based on user roles.
  • Ban/Unban Users — Administrative controls for platform moderation.
  • View History — View previously liked posts and past comments.
  • Post Visibility — Allow public and private posts
  • Redis Caching — Speeds up frequently accessed pages like user profiles or feeds.

🚀 Getting Started

  • Clone the repository:

    git clone https://github.com/EcjTn/text-feed-api.git
cd text-feed-api

  • Setup environment variables(env.example provided)

  • Run docker compose:

    docker compose up -d --build