Table of Contents
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.
- 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.
Application's Frontend can be found Here made by Igor Shevchenko.
-
Clone the repo:
$ git clone https://github.com/simatheone/bionic-reader.git
-
Prepare virtual environment and activate it:
$ cd bionic-reader/$ python3.10 -m venv venv
$ source venv/bin/activate -
Upgrade pip and install requrements:
(venv) $ pip install --upgrade pip
(venv) $ pip install -r requirements.txt
See auto-generated documentation for API to get all information about available endpoints and methods.
Have any suggestions that could improve this project? Feel free to fork the repository and create a Pull Request.
- Fork the project
- Create your feature branch:
git switch -c feature/new_feature- Commit your changes in a Commit Convention style:
git commit -m "feat: new awesome feature"- Push your branch:
git push origin feature/new_feature- Open a Pull Request
Found a bug? Open a New issue and describe it there. Your help is much appreciated!
Distributed under the MIT License. See LICENSE for more information.
Alexander Sviridov
Igor Shevchenko