PageLM

PageLM is a community-driven education platform designed to transform study materials into interactive resources. It helps students, educators, and researchers enhance learning efficiency by converting documents into quizzes, flashcards, notes, and podcasts. The platform supports various AI models and offers a modern interface for seamless learning experiences.

Benefits

PageLM offers several key advantages:-Interactive Learning: Converts study materials into engaging quizzes, flashcards, and notes.-AI-Powered Tools: Utilizes state-of-the-art LLMs and TTS systems for efficient learning.-Versatile AI Models: Supports multiple AI models like Google Gemini, OpenAI GPT, and Anthropic Claude.-Real-Time Interaction: Features WebSocket streaming for real-time chat, notes, and podcast generation.-Customizable Setup: Allows configuration of AI models, TTS engines, and database backends.

Use Cases

PageLM is ideal for:-Students: Enhancing study sessions with interactive quizzes and flashcards.-Educators: Creating engaging learning materials and podcasts.-Researchers: Organizing and retrieving information efficiently.

Technical Highlights

• WebSocket Streaming: Real-time interaction for chat, notes, and podcast generation.
• JSON or Vector Database Support: For embeddings and retrieval.
• File-Based Persistent Storage: For generated content.
• Markdown-Based Outputs: Structured answers and notes.
• Configurable Multi-Provider Setup: For LLMs and TTS engines.

Getting Started

To get started with PageLM, you need:- Node.js v21.18+- npm or pnpm- ffmpeg (required for podcast audio)- Docker (optional)

Local Development

1. Clone the repository:

git clone https://github.com/caviraOSS/pagelm.gitcd pagelm

2. For Linux:

chmod 777 ./setup.sh./setup.sh

3. For Windows:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser./setup.ps1

4. Manual Setup (Both Linux/Windows):

# Install dependenciescd backendnpm installcd ../frontendnpm install# Setup environmentcd ..npm i -g nodemoncp .env.example .env# Make sure to configure API keys and settings in .env# Run these two commands in separate terminals but inside the project directory.# Run backendcd backendnpm run dev# Run frontendcd frontendnpm run dev

Docker Deployment

# Developmentdocker compose up --build# Productiondocker compose -f docker-compose.yml -f docker-compose.prod.yml up -d --build

Configuration

All configuration is handled via environment variables:-LLM Provider: Choose your model backend-TTS Engine: Select speech service for podcasts-Database Backend: JSON or vector DB-File Upload Limits: Customize size/format limits

See.env.examplefor all options.

Community

Join the PageLM community to connect, share ideas, and participate in discussions.

Contributing

Contributions are welcome. Follow these steps:1. Fork the repository2. Create a feature branch (git checkout -b feature/new-feature)3. Commit changes (git commit -m "Add feature")4. Push (git push origin feature/new-feature)5. Open a Pull Request

Guidelines:- Follow code style and conventions- Add tests where needed- Update docs for new features- Ensure all tests pass before PR

Areas to Contribute

• AI model integrations
• Mobile app support
• Performance improvements
• Accessibility features
• Docs & tutorials

Support the Project

If you find PageLM useful, consider supporting the project:Ethereum (ERC-20):

0x5a12e3f48b6d761a120bc3cd0977e208c362a74e

Your support helps fund ongoing development and hosting.

License

PageLM is licensed under theCaviraOSS Community License. It is free to use, share, and modify for personal and educational purposes. Commercial use or resale requires prior written permission from CaviraOSS.

Built with
f49a by CaviraOSS and contributors

About

PageLM is a community-driven version of NotebookLM and an education platform that transforms study materials into interactive resources like quizzes, flashcards, notes, and podcasts.