Read-Easy BuildWithAI
by dhanushyp 
Updated: Nov 2, 2021
Solution Kit
This kit is for for the BuildWithAi Hackathon. The name of the project is "Read-Easy" This project is to provide an adaptive and immersive learning tool for students with dyslexia. Read Easy is a platform that helps teachers convert existing learning materials to suit the needs of students with dyslexia. It involves a Dyslexic Friendly Reader that provides the student to control things like Font size, Font Spacing, Read out the words, Visualise the words etc. The platform also provides a predictive assessment tool that takes in the students handwriting and checks if they are improving.
Core Frameworks
The backend is written in Flask ( Python ) which provides the API interaction between the server and the DB The frontend is written in Svelte and enables an interactive UI. Handwriting Recognition is done using Tesseract OCR module and the text to speech is based on the browsers Text to Speech Library.
tesseract.jsby naptha
30006 Version:v4.0.3Pure Javascript OCR for more than 100 Languages 📖🎉🖥
tesseract.jsby naptha
JavaScript 30006 Version:v4.0.3 License: Permissive (Apache-2.0)
web-speech-apiby mdn
1408 Version:CurrentA repository for demos illustrating features of the Web Speech API. See https://developer.mozilla.org/en-US/docs/Web/API/Web_Speech_API for more details.
web-speech-apiby mdn
JavaScript 1408 Version:Current License: Permissive (CC0-1.0)
flaskby pallets
62385 Version:2.2.3The Python micro framework for building web applications.
flaskby pallets
Python 62385 Version:2.2.3 License: Permissive (BSD-3-Clause)
svelte-spa-routerby ItalyPaleAle
1256 Version:v3.3.0Router for SPAs using Svelte 3
svelte-spa-routerby ItalyPaleAle
JavaScript 1256 Version:v3.3.0 License: Permissive (MIT)
postgresby postgres
12085 Version:CurrentMirror of the official PostgreSQL GIT repository. Note that this is just a *mirror* - we don't work with pull requests on github. To contribute, please see https://wiki.postgresql.org/wiki/Submitting_a_Patch
postgresby postgres
C 12085 Version:Current License: Others (Non-SPDX)
Other tools
tailwindcssby tailwindlabs
66696 Version:v3.3.0A utility-first CSS framework for rapid UI development.
tailwindcssby tailwindlabs
HTML 66696 Version:v3.3.0 License: Permissive (MIT)
python-docxby reddimohan
0 Version:CurrentCreate and modify Word documents with Python
python-docxby reddimohan
Python 0 Version:Current License: Permissive (MIT License)
sqlalchemyby sqlalchemy
7001 Version:rel_1_4_47The Database Toolkit for Python
sqlalchemyby sqlalchemy
Python 7001 Version:rel_1_4_47 License: Permissive (MIT)
Group Name 4
Kit Solution Source
read-easy-frontendby 4Coders-BuildwithAi
0 Version:Current
License: No License (null)read-easy-frontendby 4Coders-BuildwithAi
svelte 0 Version:Current License: No License
read-easy-backendby steinskeeper
0 Version:Current License: No License (null)read-easy-backendby steinskeeper
Python 0 Version:Current License: No License
Deployment Information
Clone both the Repository and then run each accordingly. BACKEND Create a virtualenv virtualenv [ your env name ] Create .env file in backend folder with the following fields. Replace the value according to your environment. DATABASE=postgres DB_USER=db_user_name DB_PASSWORD=db_password HOST_ADDRESS=localhost:5432 DB_NAME=db_name Install Packages pip install -r requirements.txt Create DB (Postgres) createdb db_name Development Server export FLASK_APP=server export FLASK_ENV=development # run migrations once flask db upgrade flask run FRONTEND npm install npm run dev