Skip to content

Latest commit

 

History

606 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Studzee Banner

Status as of 14-08-2026. This document is part description and part roadmap, and the two were not previously separated. The repository is midway through a v2 rewrite on the feat/v2-architecture branch, so read the architecture sections below as intent rather than as a description of what is deployed.

What actually exists today: BACKEND, a single service that owns content, notifications and email, plus the MOBILE and DESKTOP clients. The separate NOTIFICATION service was merged into BACKEND on 10-08-2026, and WEBSITE, CONVEX, AGENTS, SERVICES, PACKAGES, TERRAFORM and K8S were removed the same day. Sections describing those as present tense have been marked.

For how to actually run the project, see CLAUDE.md at the repository root, then BACKEND/README.md.

What is Studzee?

Studzee is a full-stack SaaS educational platform designed to transform how educational content is created, structured, delivered, and consumed across multiple platforms.

It unifies content ingestion, intelligent processing, secure delivery, and real-time engagement into a single ecosystem. Studzee supports document-based learning at scale while laying the foundation for AI-driven automation, enabling both manual and fully autonomous content workflows.


Who Is Studzee For?

Studzee is built for multiple stakeholders within the learning ecosystem:

  • Students & Learners Consume structured educational content, summaries, and quizzes across mobile, web, and desktop platforms.

  • Educators & Content Creators Upload documents, curate learning material, and manage structured educational resources.

  • Administrators Oversee content pipelines, approval workflows, notifications, and platform-wide operations through a dedicated control panel.

  • Developers & Contributors Work with a modular, microservice-oriented architecture designed for scalability, observability, and long-term evolution.


High-Level Architecture & System Flow

Studzee follows a distributed, service-oriented architecture with clear separation of concerns.

System Flow Overview

  1. Client Applications (Mobile, Desktop) interact with the Backend API. The web client was removed on 10-08-2026.

  2. Backend (API) handles:

    • Authentication and authorization
    • Content management
    • Caching and persistence
    • Push notifications (Expo) and transactional email
    • Orchestration of downstream services
  3. Notifications and email are part of BACKEND, not a separate service. They were merged in on 10-08-2026, and the routes moved from /noti/api to /notifications, /admin and /webhooks.

  4. Storage & Caching Layers

    • MongoDB / PostgreSQL for persistence
    • Redis for high-performance caching
    • Object storage for uploaded assets
  5. Future AI & Processing Services

    • Content validation
    • Structuring
    • Quiz & summary generation
    • External data ingestion (PDFs, web sources)

Each service is independently deployable, enabling fault isolation, horizontal scaling, and controlled rollouts.


Service Responsibilities & Boundaries

Clear responsibility boundaries ensure maintainability and scalability.

BACKEND (API)

The only service. Since the merge on 10-08-2026 it owns:

  • Core business logic
  • Content lifecycle management
  • Caching strategy and orchestration
  • Secure authentication via Clerk
  • Push notification delivery through Expo
  • Transactional email and the Clerk webhook
  • The notification and email audit logs
  • Integration point for AI and processing services

CLIENT APPLICATIONS

  • Mobile and Desktop clients. The web client was removed on 10-08-2026.
  • Content consumption and interaction
  • Platform-specific UI and UX
  • Authentication handled centrally via Backend

Future SERVICE Layer (Planned)

  • Dedicated services for:

    • PDF text extraction
    • Web scraping
    • Additional ingestion pipelines
  • Designed to be isolated, retryable, and failure-resilient


Expanded Roadmap: Agentic AI System

Current State: Content is manually uploaded and structured by administrators.

Planned Agentic AI Capabilities

The upcoming Agentic AI system will be responsible for content intelligence and automation, including:

  • Content validation and structuring
  • Automatic quiz generation
  • Intelligent summaries
  • Metadata enrichment and categorization

AI Workflows

The AI system will operate through two primary workflows:

1. PDF-Based Workflow

  • Accepts large batches of PDFs (200+)
  • Extracts raw text using a dedicated extraction service
  • Analyzes extracted content
  • Structures learning material
  • Generates summaries and quizzes

2. Web-Based Workflow

  • Accepts external links
  • Scrapes relevant educational content
  • Processes and structures extracted data
  • Generates learning artifacts (content, quizzes, summaries)

Service-First Design

  • PDF extraction and web scraping will live in separate services

  • Enables:

    • Independent scaling
    • Fault isolation
    • Easier recovery and retries
  • Additional ingestion services can be added without impacting core systems

All AI logic will reside in the upcoming Agent folder.


Deployment Strategy & Infrastructure Panels

Roadmap, not current state. The Terraform and Kubernetes definitions were removed from the repository on 10-08-2026, so the deployed topology is being redecided as part of v2. Neither panel below is provisioned from anything in this repository today.

Studzee supports two distinct deployment panels, designed for flexibility and cost optimization.

Panel 1: Free / Community Deployment

Used for testing, development, and early access environments.

  • Render
  • MongoDB Atlas
  • Neon PostgreSQL
  • Managed Redis providers
  • Docker-based deployments

This panel prioritizes cost efficiency and rapid iteration.

Panel 2: Production-Grade AWS Deployment

A fully managed, enterprise-ready infrastructure built on AWS:

  • Terraform-based infrastructure pipelines
  • Load balancing and auto-scaling
  • Secure networking and isolation
  • Domain configuration via Route 53
  • High availability and observability

This panel is optimized for performance, reliability, and scale.


Website & Public Access

  • Official Website: https://studzee.in
  • Domain management and DNS are handled through AWS Route 53 for production deployments.
  • The WEBSITE module that served it was removed from this repository on 10-08-2026.

Minor Documentation Notes

  • Releases are cut with release.sh at the repository root, which bumps the module version and prints the git commands. Releasable modules are backend, mobile and desktop.
  • The tag format is <service>-v<version>. Pushing one triggers that service's workflow. A version tag is the only thing that moves the latest image tag; a manual workflow_dispatch publishes the commit SHA only.
  • Always validate changes locally before pushing to production branches. In BACKEND, make check runs the same three gates CI does.

Testing, Containerization & Local Orchestration

All Studzee services are designed with production-readiness as a first-class concern.

Testing Strategy

  • Unit and integration testing
  • Environment-specific configurations
  • Automated test execution in CI pipelines

Testing ensures service stability, contract safety, and confidence during deployments.

Where this stands today. BACKEND has 235 tests across 26 files at 91 percent statement coverage, and its image build is gated on lint, typecheck and the suite passing, so a version tag cannot publish an image that fails its own tests. MOBILE and DESKTOP have no test or lint gate yet.

Containerization

  • Every service is packaged as an independent Docker image

  • Dockerfiles are optimized for:

    • Reproducible builds
    • Minimal runtime footprint
    • Clear separation between build and runtime stages

Local Development & Orchestration

  • Docker Compose is used for:

    • Local service orchestration
    • End-to-end testing
    • Simulating production-like environments
  • Developers can run the entire ecosystem locally without external dependencies.

This approach enables fast iteration while maintaining parity with production environments.


Future Infrastructure: Kubernetes & AWS (EKS)

Roadmap. The K8S manifests were removed on 10-08-2026 along with the Terraform definitions. Nothing below is provisioned today.

Once the core Studzee platform is fully stabilized, all services will transition to a unified cloud-native deployment model.

Kubernetes-Based Architecture

  • All services will be deployed as containers in AWS Elastic Kubernetes Service (EKS)

  • Kubernetes will handle:

    • Service discovery
    • Horizontal scaling
    • Rolling updates
    • Fault tolerance and self-healing

Complete Docker Orchestration

Studzee will operate as a fully container-orchestrated application, where:

  • Each microservice is independently deployable
  • Failures are isolated
  • Scaling policies are service-specific
  • Infrastructure changes are managed declaratively

This evolution ensures long-term scalability, resilience, and operational clarity.


Mobile Application Status

Android Application (v1)

  • The first version of the Studzee Android app is nearing completion

  • Planned Release: Google Play Store (v1)

  • Version 1.1.4 is already released. It calls POST /noti/api/register, which no longer exists after the merge, so the ingress has to rewrite that path to /notifications/register or those installs cannot register for push.

  • The initial release will focus on:

    • Content consumption
    • Notifications
    • Core learning workflows

Future releases will incrementally introduce advanced features as the platform evolves.


Why This Matters

These design decisions ensure that Studzee:

  • Scales seamlessly from development to production
  • Maintains strong reliability guarantees
  • Supports rapid experimentation without compromising stability
  • Is future-proofed for enterprise-grade deployments

About

Studzee is a scalable SaaS ed-tech platform with microservices, cross-platform apps, and future AI-powered content automation.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages