Giter VIP home page Giter VIP logo

readingguide's Introduction

1. Introduction

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

2. Run the App locally

To get started, follow these steps:

  1. Clone the repository.
  2. Install the necessary dependencies.
  3. Add you API keys in /server/.evn.example and rename the file to .env
  4. 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
  5. use docker compose docker-compose up

3. Usage

  • 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

4. Todo List

  • 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

readingguide's People

Contributors

paulomagnetico avatar

Watchers

 avatar

readingguide's Issues

Navigation not working in Github Pages

Github Pages does not support SPA Routing. Changed to the HashRouter from react-router-dom instead of custom component.

  • With current settings I can manually navigate to /#/infoPage but the link button in the navBar links to a wrong url (ReadingGuide and # are missing). Changing to the link of React-router-dom breaks the entire app (the homepage doesn't load the VideoStreamPage)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.