Skip to content

Vikleoboy/Epub-book-Reader

Repository files navigation


📚 EPUB Book Reader App

Welcome to the EPUB Book Reader App! This app is designed to enhance your reading experience by providing essential features for managing and reading EPUB files. We are currently in Stage 1 of development, focusing on the core functionalities to make reading EPUB files enjoyable and efficient. Stage 2 will introduce a minimalist social media component to share and discover books.

🚀 Features

Stage 1: Core Reading Features (In Progress)

  • Read EPUB Files: Open and read EPUB files with ease.
  • Bookmarks: Save your place in the book for quick access later.
  • Highlights: Highlight important passages or favorite quotes.
  • Tags: Organize your highlights and bookmarks with customizable tags.
  • Folders: Group your books into folders for better organization.

Stage 2: Social Media Integration (Coming Soon)

  • Share Books: Share the books you love with friends and the community.
  • Rate Books: Rate the books you read to help others discover great reads.
  • Search Books: Search for books based on ratings, tags, and user recommendations.

Currently installiation would not work , the progress on the app

image image

🔧 Installation

Requirement

1 . Python 3 2 . Node Js

To get started with the EPUB Book Reader App, follow these steps:

  1. Clone the repository:

    git clone https://github.com/Vikleoboy/Epub-book-Reader.git
  2. Navigate to the project directory:

    cd Epub-book-Reader
  3. Install the required dependencies:

    npm install
  4. Start the backend:

    npm run dev
  5. Chnage direcotry to frontEnd Dir:

    cd book_app
  6. Start the FrontEnd application:

    npm run dev

🛠️ Usage

  1. Open EPUB Files: Click on the "Open Book" button and select an EPUB file from your device.
  2. Bookmark Pages: While reading, click on the bookmark icon to save your current page.
  3. Highlight Text: Select text and click on the highlight button to highlight it.
  4. Tag Highlights: Add tags to your highlights for easy organization.
  5. Organize Books: Create folders and drag your books into them for better management.

📝 Roadmap

Current Progress

  • Stage 1: Implementing basic reading features (Bookmarks, Highlights, Tags, Folders)

Upcoming Features

  • Stage 2: Social media features (Sharing, Rating, Searching)

🌟 Contributing

We welcome contributions! If you'd like to help improve the app, please fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Join our Discord server to collaborate and discuss ideas with the community.

📧 Contact

If you have any questions or suggestions, feel free to contact us at vikleoboy@gmail.com.

Enjoy your reading! 📖✨


This project is open source and licensed under the MIT License.


You can copy this text directly into your README file.

About

No description or website provided.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published