You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
3
+
OpenReader WebUI is a web-based PDF reader with integrated Text-to-Speech capabilities. It provides a clean interface for reading PDF documents while offering synchronized text-to-speech playback using OpenAI's TTS API.
> You will need `node` and `npm` installed on your machine. If you don't have it, I recommend installing it using [nvm](https://github.com/nvm-sh/nvm).
34
44
35
-
## Getting Started
36
45
37
46
1. Clone the repository:
38
47
```bash
@@ -49,13 +58,11 @@ npm install
49
58
```bash
50
59
cp .env.template .env
51
60
```
52
-
Edit the `.env` file with your configuration settings.
61
+
> Edit the `.env` file with your configuration settings.
53
62
54
63
4. Start the development server:
55
64
```bash
56
65
npm run dev
57
-
# or
58
-
yarn dev
59
66
```
60
67
61
68
The application will be available at [http://localhost:3000](http://localhost:3000).
@@ -70,24 +77,27 @@ The application will be available at [http://localhost:3000](http://localhost:30
70
77
## Project Structure
71
78
72
79
```
73
-
openreader-webui/
74
-
├── src/
75
-
│ ├── app/ # Next.js app router pages
76
-
│ ├── components/ # Reusable React components
77
-
│ ├── contexts/ # React context providers
78
-
│ └── services/ # Business logic and services
79
-
├── public/ # Static assets
80
-
└── scripts/ # Utility scripts
80
+
src/
81
+
├── app/ # Next.js app router
82
+
├── components/ # UI components
83
+
├── contexts/ # Contexts for state management
84
+
└── services/ # Utility functions
81
85
```
82
86
83
-
## Contributing
87
+
## Browser Support
84
88
85
-
Contributions are welcome! Please feel free to submit a Pull Request.
89
+
The application requires modern browser features:
90
+
- IndexedDB for document storage
91
+
- PDF.js for document rendering
86
92
87
93
## License
88
94
89
-
This project is licensed under the terms of the license included in the repository.
95
+
MIT License
96
+
97
+
## Acknowledgements
90
98
91
-
---
99
+
-[react-pdf](https://github.com/wojtekmaj/react-pdf) for the PDF rendering library.
100
+
-[Kokoro-82M](https://huggingface.co/hexgrad/Kokoro-82M) text-to-speech model
101
+
-[Kokoro-FastAPI](https://github.com/remsky/Kokoro-FastAPI/tree/master) for the text-to-speech api wrapper.
92
102
93
-
Built with ❤️ using [Next.js](https://nextjs.org/)
0 commit comments