technology logo
technology logo

Read-Easy BuildWithAI

share link

by dhanushyp dot icon Updated: Nov 2, 2021

Solution Kit 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

JavaScript doticonstar image 30006 doticonVersion:v4.0.3doticon
License: Permissive (Apache-2.0)

Pure Javascript OCR for more than 100 Languages 📖🎉🖥

Support
    Quality
      Security
        License
          Reuse

            tesseract.jsby naptha

            JavaScript doticon star image 30006 doticonVersion:v4.0.3doticon License: Permissive (Apache-2.0)

            Pure Javascript OCR for more than 100 Languages 📖🎉🖥
            Support
              Quality
                Security
                  License
                    Reuse
                      JavaScript doticonstar image 1408 doticonVersion:Currentdoticon
                      License: Permissive (CC0-1.0)

                      A 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.

                      Support
                        Quality
                          Security
                            License
                              Reuse

                                web-speech-apiby mdn

                                JavaScript doticon star image 1408 doticonVersion:Currentdoticon License: Permissive (CC0-1.0)

                                A 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.
                                Support
                                  Quality
                                    Security
                                      License
                                        Reuse

                                          flaskby pallets

                                          Python doticonstar image 62385 doticonVersion:2.2.3doticon
                                          License: Permissive (BSD-3-Clause)

                                          The Python micro framework for building web applications.

                                          Support
                                            Quality
                                              Security
                                                License
                                                  Reuse

                                                    flaskby pallets

                                                    Python doticon star image 62385 doticonVersion:2.2.3doticon License: Permissive (BSD-3-Clause)

                                                    The Python micro framework for building web applications.
                                                    Support
                                                      Quality
                                                        Security
                                                          License
                                                            Reuse

                                                              svelteby sveltejs

                                                              TypeScript doticonstar image 66610 doticonVersion:Currentdoticon
                                                              License: Permissive (MIT)

                                                              Cybernetically enhanced web apps

                                                              Support
                                                                Quality
                                                                  Security
                                                                    License
                                                                      Reuse

                                                                        svelteby sveltejs

                                                                        TypeScript doticon star image 66610 doticonVersion:Currentdoticon License: Permissive (MIT)

                                                                        Cybernetically enhanced web apps
                                                                        Support
                                                                          Quality
                                                                            Security
                                                                              License
                                                                                Reuse

                                                                                  svelte-spa-routerby ItalyPaleAle

                                                                                  JavaScript doticonstar image 1256 doticonVersion:v3.3.0doticon
                                                                                  License: Permissive (MIT)

                                                                                  Router for SPAs using Svelte 3

                                                                                  Support
                                                                                    Quality
                                                                                      Security
                                                                                        License
                                                                                          Reuse

                                                                                            svelte-spa-routerby ItalyPaleAle

                                                                                            JavaScript doticon star image 1256 doticonVersion:v3.3.0doticon License: Permissive (MIT)

                                                                                            Router for SPAs using Svelte 3
                                                                                            Support
                                                                                              Quality
                                                                                                Security
                                                                                                  License
                                                                                                    Reuse

                                                                                                      postgresby postgres

                                                                                                      C doticonstar image 12085 doticonVersion:Currentdoticon
                                                                                                      License: Others (Non-SPDX)

                                                                                                      Mirror 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

                                                                                                      Support
                                                                                                        Quality
                                                                                                          Security
                                                                                                            License
                                                                                                              Reuse

                                                                                                                postgresby postgres

                                                                                                                C doticon star image 12085 doticonVersion:Currentdoticon License: Others (Non-SPDX)

                                                                                                                Mirror 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
                                                                                                                Support
                                                                                                                  Quality
                                                                                                                    Security
                                                                                                                      License
                                                                                                                        Reuse

                                                                                                                          Other tools

                                                                                                                          tailwindcssby tailwindlabs

                                                                                                                          HTML doticonstar image 66696 doticonVersion:v3.3.0doticon
                                                                                                                          License: Permissive (MIT)

                                                                                                                          A utility-first CSS framework for rapid UI development.

                                                                                                                          Support
                                                                                                                            Quality
                                                                                                                              Security
                                                                                                                                License
                                                                                                                                  Reuse

                                                                                                                                    tailwindcssby tailwindlabs

                                                                                                                                    HTML doticon star image 66696 doticonVersion:v3.3.0doticon License: Permissive (MIT)

                                                                                                                                    A utility-first CSS framework for rapid UI development.
                                                                                                                                    Support
                                                                                                                                      Quality
                                                                                                                                        Security
                                                                                                                                          License
                                                                                                                                            Reuse

                                                                                                                                              python-docxby reddimohan

                                                                                                                                              Python doticonstar image 0 doticonVersion:Currentdoticon
                                                                                                                                              License: Permissive (MIT License)

                                                                                                                                              Create and modify Word documents with Python

                                                                                                                                              Support
                                                                                                                                                Quality
                                                                                                                                                  Security
                                                                                                                                                    License
                                                                                                                                                      Reuse

                                                                                                                                                        python-docxby reddimohan

                                                                                                                                                        Python doticon star image 0 doticonVersion:Currentdoticon License: Permissive (MIT License)

                                                                                                                                                        Create and modify Word documents with Python
                                                                                                                                                        Support
                                                                                                                                                          Quality
                                                                                                                                                            Security
                                                                                                                                                              License
                                                                                                                                                                Reuse

                                                                                                                                                                  vscodeby microsoft

                                                                                                                                                                  TypeScript doticonstar image 144275 doticonVersion:1.77.0doticon
                                                                                                                                                                  License: Permissive (MIT)

                                                                                                                                                                  Visual Studio Code

                                                                                                                                                                  Support
                                                                                                                                                                    Quality
                                                                                                                                                                      Security
                                                                                                                                                                        License
                                                                                                                                                                          Reuse

                                                                                                                                                                            vscodeby microsoft

                                                                                                                                                                            TypeScript doticon star image 144275 doticonVersion:1.77.0doticon License: Permissive (MIT)

                                                                                                                                                                            Visual Studio Code
                                                                                                                                                                            Support
                                                                                                                                                                              Quality
                                                                                                                                                                                Security
                                                                                                                                                                                  License
                                                                                                                                                                                    Reuse

                                                                                                                                                                                      sqlalchemyby sqlalchemy

                                                                                                                                                                                      Python doticonstar image 7001 doticonVersion:rel_1_4_47doticon
                                                                                                                                                                                      License: Permissive (MIT)

                                                                                                                                                                                      The Database Toolkit for Python

                                                                                                                                                                                      Support
                                                                                                                                                                                        Quality
                                                                                                                                                                                          Security
                                                                                                                                                                                            License
                                                                                                                                                                                              Reuse

                                                                                                                                                                                                sqlalchemyby sqlalchemy

                                                                                                                                                                                                Python doticon star image 7001 doticonVersion:rel_1_4_47doticon License: Permissive (MIT)

                                                                                                                                                                                                The Database Toolkit for Python
                                                                                                                                                                                                Support
                                                                                                                                                                                                  Quality
                                                                                                                                                                                                    Security
                                                                                                                                                                                                      License
                                                                                                                                                                                                        Reuse

                                                                                                                                                                                                          Group Name 4

                                                                                                                                                                                                          Kit Solution Source

                                                                                                                                                                                                          read-easy-frontendby 4Coders-BuildwithAi

                                                                                                                                                                                                          svelte doticonstar image 0 doticonVersion:Currentdoticon
                                                                                                                                                                                                          no licences License: No License (null)

                                                                                                                                                                                                          Support
                                                                                                                                                                                                            Quality
                                                                                                                                                                                                              Security
                                                                                                                                                                                                                License
                                                                                                                                                                                                                  Reuse

                                                                                                                                                                                                                    read-easy-frontendby 4Coders-BuildwithAi

                                                                                                                                                                                                                    svelte doticon star image 0 doticonVersion:Currentdoticonno licences License: No License

                                                                                                                                                                                                                    Support
                                                                                                                                                                                                                      Quality
                                                                                                                                                                                                                        Security
                                                                                                                                                                                                                          License
                                                                                                                                                                                                                            Reuse

                                                                                                                                                                                                                              read-easy-backendby steinskeeper

                                                                                                                                                                                                                              Python doticonstar image 0 doticonVersion:Currentdoticon
                                                                                                                                                                                                                              no licences License: No License (null)

                                                                                                                                                                                                                              Support
                                                                                                                                                                                                                                Quality
                                                                                                                                                                                                                                  Security
                                                                                                                                                                                                                                    License
                                                                                                                                                                                                                                      Reuse

                                                                                                                                                                                                                                        read-easy-backendby steinskeeper

                                                                                                                                                                                                                                        Python doticon star image 0 doticonVersion:Currentdoticonno licences License: No License

                                                                                                                                                                                                                                        Support
                                                                                                                                                                                                                                          Quality
                                                                                                                                                                                                                                            Security
                                                                                                                                                                                                                                              License
                                                                                                                                                                                                                                                Reuse

                                                                                                                                                                                                                                                  Deployment Information

                                                                                                                                                                                                                                                  Please add your kit solution or prototype source repository in this section.

                                                                                                                                                                                                                                                  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