Skip to main content
This guide will help you get Uxie up and running on your local machine quickly. You’ll set up the application, create an account, and explore the core features.

​
Prerequisites

Before you begin, ensure you have:
  • Node.js v18 or later installed
  • pnpm package manager
  • Git for cloning the repository
If you don’t have pnpm installed, run npm install -g pnpm to install it globally.

​
Quick Setup

1

Clone the repository

git clone https://github.com/zeus-12/uxie.git
cd uxie
2

Install dependencies

pnpm install
This will install all required packages and automatically generate the Prisma client.
3

Set up environment variables

Copy the example environment file:
cp .env.example .env
At minimum, you’ll need to configure:
.env
DATABASE_URL="postgresql://user:password@localhost:5432/uxie"
NEXTAUTH_SECRET="your-secret-here"
NEXTAUTH_URL="http://localhost:3000"
GOOGLE_CLIENT_ID="your-google-client-id"
GOOGLE_CLIENT_SECRET="your-google-client-secret"
Generate a secure NEXTAUTH_SECRET using openssl rand -base64 32
For full functionality, you’ll also need API keys for:
  • Supabase (database)
  • Uploadthing (PDF storage)
  • Pinecone (vector embeddings)
  • Google AI (LLM features)
  • Hugging Face (embeddings)
  • Liveblocks (real-time collaboration)
See the Installation guide for detailed configuration.
4

Set up the database

Push the Prisma schema to your database:
pnpm prisma db push
This creates all necessary tables in your PostgreSQL database.
5

Start the development server

pnpm dev
The application will be available at http://localhost:3000

​
First Steps with Uxie

Once your application is running, here’s how to get started:
1

Create an account

  1. Navigate to http://localhost:3000
  2. Click “Sign in” and authenticate with Google
  3. Your account will be created automatically
2

Upload your first PDF

  1. Click the “Upload” button on the dashboard
  2. Select a PDF file from your computer
  3. Wait for the upload to complete (progress indicator will show)
  4. The PDF will appear in your document library
PDFs are stored using Uploadthing. For local development without Uploadthing, some features may be limited.
3

Explore core features

After uploading, you can:Reading & Annotation
  • Highlight text by selecting it with your mouse
  • Add notes by clicking on highlights
  • Create image highlights by selecting areas
AI-Powered Features
  • Ask questions about the PDF content
  • Get AI-generated summaries
  • Generate flashcards for learning
  • Use text-to-speech for hands-free reading
Note-Taking
  • Use the BlockNote editor for rich text notes
  • Add custom blocks and formatting
  • Download notes as Markdown
4

Try AI features

  1. Open a PDF document
  2. Click the AI Chat button
  3. Ask questions like:
    • “Summarize this document”
    • “What are the key points on page 5?”
    • “Explain this concept in simple terms”
AI features require GOOGLE_GENERATIVE_AI_API_KEY and PINECONE_API_KEY to be configured.
5

Generate flashcards

  1. Navigate to the Flashcards section
  2. Click “Generate Flashcards”
  3. The AI will create questions based on your PDF
  4. Answer questions and receive instant feedback
The system uses AI evaluation to provide detailed feedback on your responses.

​
Reading Modes

Uxie offers several specialized reading modes to enhance your learning:
  • Bionic Reading Mode: Helps you read faster by highlighting key parts of words
  • RSVP Reading Mode: Displays one word at a time for focused reading
  • Read-Along Mode: Highlights text as it’s being read aloud
  • Full-Screen View: Distraction-free reading experience

​
Next Steps

Installation Guide

Complete setup instructions with all environment variables

Core Features

Explore all available features in detail

API Reference

Learn about the tRPC API endpoints

Contributing

Contribute to Uxie’s development

​
Troubleshooting

Make sure:
  • Node.js v18 or later is installed
  • All dependencies are installed (pnpm install)
  • Environment variables are properly set
  • Port 3000 is not in use by another application
Verify:
  • PostgreSQL is running
  • DATABASE_URL is correctly formatted
  • Database exists and is accessible
  • Run pnpm prisma db push to sync the schema
Check:
  • GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET are valid
  • NEXTAUTH_SECRET is set
  • NEXTAUTH_URL matches your application URL
  • Google OAuth redirect URIs include http://localhost:3000/api/auth/callback/google
Ensure:
  • UPLOADTHING_TOKEN is configured
  • You have an active Uploadthing account
  • The PDF file is valid and not corrupted

​
Need Help?

If you encounter issues:
  1. Check the Installation guide for detailed configuration
  2. Review GitHub Issues for known problems
  3. Open a new issue with details about your problem
  4. Submit feedback through the app at https://uxie.vercel.app/feedback

Build docs developers (and LLMs) love

Get started for freeTalk to us