Repository files navigation

TheBionic 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!

• 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

Application's Frontend can be foundHere made byIgor Shevchenko.

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

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

• Swagger
• ReDoc

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

1. Fork the project
2. Create yourfeature branch:

git switch -c feature/new_feature

3. Commit your changes in aCommit Convention style:

git commit -m"feat: new awesome feature"

4. Push your branch:

git push origin feature/new_feature

5. Open aPull Request

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

Distributed under the MIT License. SeeLICENSE for more information.

Alexander Sviridov
   

Igor Shevchenko
   

Back to Contents