Skip to content

a simple flet project that enhances the reading experience

License

Notifications You must be signed in to change notification settings

phanstudio/flet-reader

Repository files navigation

Flet Book Reader App

Welcome to the Flet Book Reader App! This application is built using Flet, a Python web framework designed for simplicity and ease of use. The Flet Book Reader App provides a seamless experience for readers who want to explore, organize, and enjoy their favorite books in a digital format.

Table of Contents

  1. Demo
  2. Features
  3. Installation
  4. Usage
  5. Contributing
  6. License

Demo

youtube

images

image Screenshot 2023-11-26 154716

Features

  • Book Library: Organize and manage your digital book collection.
  • Read Anywhere: Enjoy your favorite books on any device with a responsive design.
  • Customizable Reading Experience: Adjust fonts, themes, and settings for a personalized reading experience.
  • Search Functionality: Quickly find and discover new books in your library.
  • Bookmarking: Easily mark your progress and return to where you left off.
  • Offline Reading: Download books for offline reading convenience.

Installation

Follow these steps to set up the Flet Book Reader App locally:

  • use python < 3.12
  1. Clone the Repository:

    git clone https://github.com/your-username/flet-reader.git
  2. Navigate to the Project Directory:

    cd flet-reader
  3. Create a Virtual Environment:

    python -m venv venv
  4. Activate the Virtual Environment:

    • On Windows:
      venv\Scripts\activate
    • On Unix or MacOS:
      source venv/bin/activate
  5. Install Dependencies:

    pip install -r requirements.txt
  6. Start the Development Server:

    flet run 

Visit http://localhost:8000 in your browser to access the Flet Book Reader App.

Usage

  1. Upload Your Books:

    • Visit the /upload endpoint to add books to your digital library.
  2. Browse and Read:

    • Explore your library on the /library page and start reading your books.
  3. Customize Your Reading Experience:

    • Adjust fonts, themes, and other settings to create a comfortable reading environment.
  4. Bookmark and Resume:

    • Use the bookmark feature to mark your progress and easily resume reading.

Contributing

If you would like to contribute to the development of this project, please follow our contribution guidelines.

License

This project is licensed under the Apache-2.0 license. Feel free to use, modify, and distribute the code for your own projects.

Happy Reading! 📚

About

a simple flet project that enhances the reading experience

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages