README.md

SummarZ 📚

SummarZ is a self-hosted web application that summarizes PDF books chapter-by-chapter using AI (Mistral AI via the condensr library).

See demo

✨ Features

• Chapter-by-Chapter Summary: Processes books granularly for better retention.
• Real-time Streaming: Watch the summary appear as it's being generated.
• Modern UI: Dark-mode, Glassmorphism design built with React and Tailwind CSS.
• CRUD Library: Manage your collection of summaries easily.
• Export: Download your summaries as beautifully styled PDFs or Markdown.
• Self-Hosted: You own your data. Supports opt-in Basic Authentication.

🚀 Getting Started

Prerequisites

• Docker and Docker Compose
• A Mistral AI API Key (Get one at console.mistral.ai)

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/summarz.git
   cd summarz

2. Create a .env file from the example:

   cp .env.example .env

3. Add your MISTRAL_API_KEY to the .env file.

4. Start the stack:

   docker-compose up --build

5. Access the app at http://localhost:5173.

🛠 Tech Stack

• Backend: FastAPI (Python), SQLAlchemy, SQLite, condensr, WeasyPrint.
• Frontend: React, TypeScript, Tailwind CSS, Lucide Icons, Framer Motion.
• Deployment: Docker, Docker Compose.

🧪 Testing

Backend

cd api
pytest

Frontend

cd web
npm test

📄 License

This project is licensed under the AGPL-3.0 License - matching the condensr library dependency.