No description
| public | ||
| scripts | ||
| src | ||
| .env.template | ||
| .gitignore | ||
| empty-module.ts | ||
| eslint.config.mjs | ||
| LICENSE | ||
| next.config.ts | ||
| package-lock.json | ||
| package.json | ||
| postcss.config.mjs | ||
| README.md | ||
| tailwind.config.ts | ||
| tsconfig.json | ||
OpenReader WebUI
OpenReader WebUI is a modern, user-friendly web interface for reading and analyzing PDF documents. Built with Next.js and React, it provides an intuitive interface for document viewing, analysis, and interaction. The application features drop-in support for any OpenAI-compatible Text-to-Speech (TTS) API, making it highly flexible for various voice synthesis implementations.
Demo
https://github.com/user-attachments/assets/cd645dd6-65f1-4ef1-81be-9cc26fdf8aca
Features
- PDF document viewing and navigation
- Interactive document interface
- Modern UI with Tailwind CSS
- Fast performance with Next.js and Turbopack
- PDF text analysis capabilities
- Drop-in support for OpenAI-compatible TTS APIs
- Responsive design for various screen sizes
Tech Stack
- Framework: Next.js 15
- UI Library: React 19
- Styling: Tailwind CSS
- PDF Processing: React-PDF and PDF.js
- UI Components: Headless UI
- Type Safety: TypeScript
Prerequisites
- Node.js 18.x or higher
- npm or yarn package manager
Getting Started
- Clone the repository:
git clone [repository-url]
cd openreader-webui
- Install dependencies:
npm install
# or
yarn install
- Set up environment variables:
cp .env.template .env
Edit the .env file with your configuration settings.
- Start the development server:
npm run dev
# or
yarn dev
The application will be available at http://localhost:3000.
Available Scripts
npm run dev- Start development server with Turbopacknpm run build- Create production buildnpm run start- Start production servernpm run lint- Run ESLint for code quality
Project Structure
openreader-webui/
├── src/
│ ├── app/ # Next.js app router pages
│ ├── components/ # Reusable React components
│ ├── contexts/ # React context providers
│ └── services/ # Business logic and services
├── public/ # Static assets
└── scripts/ # Utility scripts
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the terms of the license included in the repository.
Built with ❤️ using Next.js