Project Alexandria Documentation

Your comprehensive guide to the AI-powered digital library platform. Learn features, explore technology, and get started.

Introduction

Alexandria is an innovative eReader that empowers you to highlight any text within your eBooks and instantly generate AI-powered images based on your selection. Designed for readers, students, and educators, Alexandria brings your reading experience to life by visually enhancing stories, textbooks, and more.

Key Features

  • Highlight-to-Image:Select any text in your eBook and generate unique AI images
  • ePub Reading:Read ePub books directly in your browser with smooth, responsive interface
  • Personal Library:Upload, organize, and manage your ePub collection
  • Image Gallery:View and revisit all AI-generated images from your highlights
  • Secure Authentication:User authentication and cloud storage powered by Supabase

Technology Stack

Frontend

  • • Next.js - React framework for SSR
  • • Tailwind CSS - Utility-first styling
  • • Framer Motion - Smooth animations
  • • Zustand - State management

Backend & Services

  • • Supabase - Database & auth
  • • OpenAI - AI image generation
  • • Resend - Email notifications
  • • epubjs - ePub rendering

Architecture Overview

  • Frontend: Built with Next.js and React, using Tailwind CSS for styling. Handles reading, highlighting, and user interactions.
  • Backend: Next.js API routes and Supabase for authentication, storage, and managing highlights/images. OpenAI API is called for image generation.
  • Email Service: Resend is used for sending notifications and user communications.

How It Works

  1. Sign Up & Library: Create an account and upload your ePub books to your personal library.
  2. Read & Highlight: Open a book, select any text passage, and use the highlight feature.
  3. Generate Image: After highlighting, click the "Generate Image" button to create an AI-generated image based on your selection.
  4. View & Save: The generated image appears alongside your highlight and is saved to your image gallery for future reference.
  5. Manage Content: Organize your books and generated images, and receive notifications about your activity.

Getting Started

  1. Sign Up: Register for a free account or log in.
  2. Upload Books: Add your ePub files to your library.
  3. Start Reading: Open a book and begin reading in the eReader.
  4. Highlight & Generate: Select text, highlight it, and click "Generate Image" to see your AI-powered illustration.
  5. Explore Gallery: Access all your generated images from the gallery section.

Usage Examples

  • Visualize Stories: Highlight a scene in a novel to generate a vivid illustration of the moment.
  • Study Aid: Select a concept or definition in a textbook and create a visual summary for better retention.
  • Creative Inspiration: Highlight poetry or descriptive passages to see how AI interprets the imagery.
  • Share & Discuss: Use your generated images to spark discussion or share insights with others.

FAQ

How do I generate an image?

Highlight any text in your eBook and click the "Generate Image" button that appears.

What file types are supported?

Alexandria currently supports ePub files for reading and highlighting.

Where are my images saved?

All generated images are saved in your personal gallery, accessible from your dashboard.

Is my data private?

Yes, your books, highlights, and images are securely stored and only accessible to you.

Can I use my own eBooks?

Yes, you can upload any ePub file you own.

Support

For help, feedback, or feature requests, please contact our support team or visit the project repository for more information. We're here to help you get the most out of Alexandria.

Need Help?

For additional support, feature requests, or technical questions, please visit our contact page or reach out to our support team.

Project Alexandria | Documentation | Project Alexandria