Skip to content

danielpetrupascu-cell/KnowledgeScroll

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KnowledgeScroll - TikTok-Style Knowledge Tree Learning Platform

CI Pipeline

KnowledgeScroll is a revolutionary mobile application that transforms compulsive scrolling into an accelerated and engaging learning experience. It reimagines the TikTok-style vertical feed as an interactive platform for exploring vast knowledge trees, where gesture-based interactions trigger AI-powered content generation.

Core Features

  • Infinite Vertical Feed: Scroll through branches of a knowledge tree, just like a social media feed.
  • Gesture-Based Interaction: A unique double-tap-and-hold gesture opens a radial menu (the "Rotor") with 8 distinct options for generating educational content.
  • AI-Powered Content: Leveraging Gemini 2.5 Pro, the app generates diverse content types on demand, from in-depth articles and visual tables to real-world examples and interactive quizzes.
  • Gamification: A robust system tracks user progress with streaks, badges, knowledge scores, and levels to keep learners motivated.
  • Adaptive Learning: The app analyzes user interactions to recommend the most relevant next piece of content, tailoring the learning path to individual interests and engagement levels.

Architecture Overview

The project is a monorepo containing the mobile application and the backend API.

knowledgescroll/
├── mobile/      # React Native application
├── backend/     # Node.js/Express API server
├── database/    # PostgreSQL migrations and schema
├── docs/        # Project documentation
├── tests/       # E2E and integration tests
└── .github/     # CI/CD workflows

Tech Stack

  • Mobile: React Native, TypeScript, Redux Toolkit, React Navigation, Reanimated
  • Backend: Node.js, Express, TypeScript
  • AI Model: Google Gemini 2.5 Pro
  • Databases:
    • PostgreSQL (for user data, progress)
    • MongoDB (for flexible knowledge tree structures)
    • Redis (for caching)
  • DevOps: Docker, GitHub Actions

Getting Started

Prerequisites

  • Node.js (v18+)
  • Docker and Docker Compose
  • An account with Google AI Studio to get a GEMINI_API_KEY.

Local Development

  1. Clone the repository:

    git clone https://github.com/danielpetrupascu-cell/KnowledgeScroll.git
    cd KnowledgeScroll
  2. Set up environment variables:

    • Copy backend/.env.example to backend/.env.
    • Fill in the required API keys and database URLs.
  3. Launch services:

    docker-compose up -d

    This will start PostgreSQL, MongoDB, and Redis containers.

  4. Install dependencies:

    # For the backend
    cd backend && npm install
    
    # For the mobile app
    cd ../mobile && npm install
  5. Run the applications:

    # Run the backend (from the 'backend' directory)
    npm run dev
    
    # Run the mobile app (from the 'mobile' directory, in a new terminal)
    npm start
    # Then run on a simulator
    npm run ios
    # or
    npm run android

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

KnowledgeScroll

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors