simatheone / bionic-reader

API for the service Bionic Reader

Bionic Reader Backend

Table of Contents

• About The Project
  • Disclaimer
  • Built With
• Getting Started
  • Installation
• Contributing
• License
• Contacts

About the Project

Disclaimer

The Bionic Reading method is not our invention!
The developed service was created as a hobby project and is absolutely free of charge. It is not used for commercial purposes. Anyone can register and use the service absolutely for free!

Bionic Reading is a technique that allows you to highlight a certain number of letters in the text. While reading your brain is focusing on the highlighted letters and completes the words (non-highlighted letters). It can increase your reading speed and understanding of the content.

Experience it now!

Features

• transform your text even if you are not logged in;
• save every transformed text in a document and download it as PDF file (account required);
• English and Russian languages are supported;
• up to 59 documents per page;
• email with the unique link if you forgot your password;
• the service is adapted for mobile and tablets.

Back to Contents

Built With

Backend

Frontend

Application's Frontend can be found Here made by Igor Shevchenko.

Getting Started

Installation

1. Clone the repo:

   $ git clone https://github.com/simatheone/bionic-reader.git

2. Prepare virtual environment and activate it:

   $ cd bionic-reader/

   $ python3.10 -m venv venv

   $ source venv/bin/activate

3. Upgrade pip and install requrements:

   (venv) $ pip install --upgrade pip

   (venv) $ pip install -r requirements.txt

Back to Contents

API

See auto-generated documentation for API to get all information about available endpoints and methods.

• Swagger
• ReDoc

Contributing

Have any suggestions that could improve this project? Feel free to fork the repository and create a Pull Request.

1. Fork the project
2. Create your feature branch:

git switch -c feature/new_feature

3. Commit your changes in a Commit Convention style:

git commit -m "feat: new awesome feature"

4. Push your branch:

git push origin feature/new_feature

5. Open a Pull Request

Found a bug? Open a New issue and describe it there. Your help is much appreciated!

License

Distributed under the MIT License. See LICENSE for more information.

Contacts

Alexander Sviridov
   

Igor Shevchenko
   

Back to Contents

bionic-reader's Issues

Update starlette to safe version

right now it's 0.25.0, needs to be 0.27.0

Fix `cryptography` vulnerability

Need to update dependency

libwebp: OOB write in BuildHuffmanTable