Skip to content

ranuts/weread

Repository files navigation

weread logo

A pristine web reader with privacy-first architecture

license PRs welcome! Build Status forks stars

🌐 Live Demo✨ Features🛠️ Tech Stack🚀 Getting Started


This project is for learning and exchange purposes only. If you find any issues, please submit an issue or PR. It's intended for learning and exchange only; using it for other purposes isn't advised.

English · 中文

📖 About

"Entities Unnecessarily Posited Must Not Exist" - Occam's Razor

Weread is a minimalist, privacy-focused web reader that provides a clean reading experience without any unnecessary complexity. Built with modern web technologies, it offers a native app-like experience through PWA capabilities.

✨ Features

  • 📂 Local First - Import TXT books directly from your device
  • 🔒 Zero Commitment - No accounts, no signups, no strings attached
  • 🔐 Privacy by Default - No analytics, no telemetry, no data collection
  • 🚫 No Server - Zero backend dependencies (pure client-side)
  • PWA Magic - Add to home screen & read offline like native apps
  • 📱 Responsive Design - Optimized for both desktop and mobile devices
  • 🌍 Multi-language Support - English and Chinese interfaces
  • 🔍 Smart Search - Search by title, author, or content
  • 📖 Reading Progress - Automatic progress tracking and bookmarking
  • 🎨 Modern UI - Clean, distraction-free reading interface
  • ⚙️ Customizable - Adjustable font size, theme, and reading preferences

🛠️ Tech Stack

  • Frontend Framework: React 19 + TypeScript
  • Build Tool: Vite 6
  • Styling: Tailwind CSS 4 + SCSS
  • State Management: Custom store with IndexedDB
  • Routing: React Router DOM
  • PWA: Service Worker + Web App Manifest
  • UI Components: Custom components + RanUI
  • Text Processing: Custom text transformation and encoding detection
  • Package Manager: pnpm

🚀 Getting Started

Prerequisites

  • Node.js >= 23.10.0
  • pnpm (recommended) or npm

Installation

  1. Clone the repository

    git clone https://github.com/ranuts/weread.git
    cd weread
  2. Install dependencies

    pnpm install
  3. Start development server

    pnpm dev
  4. Open your browser Navigate to http://localhost:5173

Building for Production

# Build for production
pnpm build

# Preview production build
pnpm preview

📱 Usage

  1. Add Books: Click the "+" button to import TXT files from your device
  2. Read: Click on any book to start reading
  3. Navigate: Use arrow keys or swipe gestures to turn pages
  4. Search: Use the search bar to find books by title, author, or content
  5. Install: Add to home screen for offline access (PWA)

🏗️ Project Structure

weread/
├── components/          # Reusable UI components
├── pages/              # Page components
├── store/              # State management
├── lib/                # Utility functions
├── styles/             # Global styles
├── locales/            # Internationalization
├── assets/             # Static assets
├── public/             # Public assets
└── workers/            # Web workers

🤝 Contributing

We welcome contributions! Please feel free to submit issues and pull requests.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

  • Thanks to all contributors who have helped improve this project
  • Inspired by the need for a simple, privacy-focused reading experience

📊 Contributors

📈 Visitors


📚 Useful E-book Resources

English

  • Z-Library: The well-known Shadow Library boasts a vast collection of multi-language and multi-format e-book resources. An average user can download 10 e-books every day.
  • Anna's Archive: A shadow library search engine that catalogues all existing books by aggregating data from various sources.
  • Library Genesis+: The well-known Shadow Library, with formats including PDF, MOBI and EPUB.
  • sci-hub: The world's first website that provides tens of millions of research papers to the public. Enter the DOI of the paper to obtain it.
  • Trantor: An EPUB format DRM-free e-book repository.
  • VDOC.PUB: Free foreign language e-book download sites. There are various formats such as EPUB, PDF, DJVU, MOBI, etc.
  • PDF DRIVE: PDF Drive is a PDF document search engine that can be downloaded for free and is mostly in PDF format.
  • The Pirate Bay: You can select the Ebook category or search for the desired English e-books by keywords such as MOBI, EPUB, AZW3, etc.
  • 1337x: You can search for the desired English e-books by choosing the "Other" category or through keywords such as MOBI, EPUB, AZW3, etc.
  • Project Gutenberg: Free e-book downloads in formats such as MOBI and EPUB are provided. The Gutenberg Project was the world's first digital library, offering a large number of books whose Copyrights had expired and entered the public domain (public edition books).[here] (https://www.gutenberg.org/browse/languages/zh) also provide some Chinese male version download books.
  • Standard Ebooks: Free remastered and finely proofread public e-books are provided in EPUB, AZW3 and KPEUB formats.
  • DigiLibraries: Free e-book library, with over 20,000 free e-books, offering e-books in formats such as MOBI, EPUB, and PDF.
  • MobileRead(EPUB): The copyright-free EPUB format e-book upload area on the MobileRead forum allows you to download directly without registration.
  • MobileRead(MOBI): The copyright-free MOBI format e-book upload area of the MobileRead Forum allows you to download directly without registration.
  • epubBooks: Provide high-quality EPUB format and MOBI format public e-books for Kindle, among which there are many well-made illustrations and footnotes. Before downloading e-books, you must register and activate an account using an email address.
  • Planetebook: Free English e-book download site. It is available in EPUB, MOBI and PDF formats.
  • Girlebooks: Free e-books by female writers, available in PRC format suitable for Kindle reading, as well as EPUB, PDF, Microsoft Reader, PDB and plain text formats.
  • Green Tea Press: Free downloads of original English e-books such as "Think Python" and "Think Bayes" are provided. These e-books allow readers to copy and distribute their contents, freely edit them according to different needs, and help expand new contents.
  • Baen Free Library: Free science fiction and fantasy books are provided. It provides online reading and also offers downloads in multiple formats, such as HTML, MOBI, EPUB, RTF, SONY e-book format, Microsoft Reader format, etc.
  • Let Me Read: English e-book download sites. It is available in EPUB, MOBI and PDF formats. Download it at the "Free sample" section at the bottom of the page.
  • CODERPROG: English e-book download sites. It is available in EPUB, MOBI and PDF formats. Download it at the "Free sample" section at the bottom of the page.

中文 (简体)

  • Jiumo Search:One-stop integrated search of numerous e-book resources. We offer various e-book formats, including text, PDF, mobi, epub, and so on. When you click on each share, you will find a link to the cloud disk
  • 搬书匠: It mainly provides the download of programming books. According to the feedback from programmer friends, the books above are quite complete. Those who need them can go and have a look.
  • SaltTiger: The newly published electronic books on computer technology. Available for download in MOBI, PDF and EPUB formats.

中文 (繁體)

  • 好讀:A public welfare website for Chinese e-books, providing downloads of e-books in formats such as mobi and epub.

Releases

No releases published

Packages

No packages published