Skip to content

Latest commit

 

History

History
291 lines (233 loc) · 8.88 KB

README.md

File metadata and controls

291 lines (233 loc) · 8.88 KB

🌟 OpenBookLM: Democratizing Learning with AI 🌟

Contributors Forks Stargazers Issues MIT License

Logo

OpenBookLM: Revolutionizing Content Comprehension

Unlock the power of AI-driven learning with our open-source platform 🚀
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Challenges
  4. Advice for Contributors
  5. Contributing
  6. License
  7. Contact

About The Project

OpenBookLM Screen Shot

"OpenBookLM is a game-changer in the education sector, providing an open-source platform for AI-driven learning experiences." 🎓🌏

Concept 📖

OpenBookLM is designed to bridge the gap between traditional learning methods and modern AI-driven approaches. Our platform empowers users to create and share interactive, audio-based courses, while leveraging the power of AI for enhanced learning experiences.

Target Audience 🎯

  • Students 📚

    • High school and university students
    • Graduate researchers
    • Academic professionals

  • Lifelong Learners 🧠

    • Self-directed learners
    • Professional development enthusiasts
    • Knowledge seekers

Key Features ✨

Open Source Framework 🔓

  • Integration with various AI models
  • Flexible and customizable architecture
  • Community-driven development

Audio Course Creation 🎧

  • Create and share educational podcasts
  • Multilingual text-to-audio generation using Suno bark
  • High-quality audio content management

Collaborative Learning 🌍

  • Forum-like community system
  • Course rating and refinement
  • Knowledge sharing platform

Multilingual Support 🌐

  • Overcome English-only limitations
  • Support for multiple languages
  • Inclusive learning environment

System Architecture

graph TD
    subgraph Client
        UI[Next.js Frontend]
        Auth[Clerk Auth]
    end

    subgraph Server
        API[Next.js API Routes]
        LLM[LLM Service]
        Cache[Redis Cache]
    end

    subgraph Database
        PG[(PostgreSQL)]
        Prisma[Prisma ORM]
    end

    subgraph External
        Cerebras[Cerebras API]
        Sources[External Sources]
    end

    UI --> Auth
    UI --> API
    API --> LLM
    API --> Cache
    API --> Prisma
    Prisma --> PG
    LLM --> Cerebras
    LLM --> Sources
Loading

Built With

  • Next
  • React
  • TypeScript
  • Tailwind
  • Prisma
  • PostgreSQL

Challenges ⚠️

GPU Hosting 💻

  • Managing high computational power requirements
  • Optimizing resource allocation
  • Cost-effective scaling solutions

Text-to-Audio Pipelines 🗣️

  • Ensuring high-quality audio output
  • Managing pre-generated transcripts
  • Supporting multiple languages efficiently

Community Integration 🤲

  • Building a curated content platform
  • Managing user contributions
  • Maintaining quality standards

Advice for Contributors ⚡

Rapid AI Prototyping 🌀

"The simplest way to build an awesome product? Replicate an existing one, but add a unique twist or focus on a different market!"

Our twist:

  • Open-source accessibility
  • Multilingual capabilities
  • Global collaboration features

Market Gap Focus 🔍

  • Addressing language restrictions
  • Providing open-source alternatives
  • Enabling community-driven learning

Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

  • Node.js (v20 or later)
  • pnpm 
    npm install -g pnpm
  • Python (3.8 or later)

Installation

  1. Clone the repo 
    git clone https://github.com/open-biz/OpenBookLM.git
  2. Install dependencies 
    pnpm install
  3. Set up Python environment 
    ./setup/create_venv.sh
source venv/bin/activate
  4. Create a .env file with your environment variables 
    cp .env.example .env
  5. Start the development server 
    pnpm dev

(back to top)

Usage

  1. Create a Notebook: Start by creating a new notebook for your study topic
  2. Add Sources: Upload URLs, documents, or other study materials
  3. Take Notes: Use the AI-powered interface to take and organize notes
  4. Study & Review: Engage with your materials through interactive features
  5. Share & Collaborate: Join the community and share your knowledge

(back to top)

Features

  • Dark mode by default
  • Modern UI with shadcn components
  • Notebook management
  • Community courses section
  • Interactive chat interface
  • Source management
  • Notes and study tools
  • Real-time updates
  • Progress tracking

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/open-biz/OpenBookLM

(back to top)