Welcome to the Reading Guide! This app will help you with classifying childrens book by reading difficulties. A version of the Front-end is hosted here, currently without working backend
To get started, follow these steps:
- Clone the repository.
- Install the necessary dependencies.
- Add you API keys in
/server/.evn.example
and rename the file to.env
- To set up HTTPS for local development, you need a SSL certificate (server.cert) and a private key (server.key). The following instructions will guide you through the process of generating these files using OpenSSL
- install openssl
sudo apt-get install openssl
openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout server.key -out server.cert
- save the key and cert file in the
/server
folder
- install openssl
- use docker compose
docker-compose up
- scan a book page using your phone camera
- the app will show if there is any text found using Google Cloud Vision
- hit the analyze tekst button for
- the app will analyze and classify the tekst using ChatGPT
- user can send feedback
- the feedback can be viewed in the admin dashboard
- the feedback can be exported in a format that can be used to train the GPT model
- Host on Github Pages
- Host backend on google cloud run
- Configure environments to manage connection
- Host mongoDB using Atlas
-
Create submodules for independen deployments - Make backend only accessible through frontend
- set up testing following this guide