Skip to content

Abyl10/samsung-front

Repository files navigation

Interactive Reading Web App

This is a frontend repository of the website presented on the Samsung Hackathon. The backend is located here: https://github.com/elamirKad/samsung-api

Delpoyed Swagger Links: http://162.19.255.157/docs http://162.19.255.244/docs http://162.19.255.208/docs

Introduction

This project represents a unique web-based literature reading experience, equipped with a text-to-speech feature and adjustable reading speed functionality. It is specifically designed with the aim of helping children suffering from dyslexia. The text is highlighted as it's being read, and GPT-4 generates prompts for an engaging reading session.

What's more, the generated prompts are used in another platform - Midjourney API, which creates vivid illustrations based on these prompts. In this way, not only is a child's reading skill enhanced, but their imagination is also stimulated.

In addition, during the reading process, the child has the opportunity to choose the development of events, putting themselves in the shoes of the main character. This makes the reading process even more interactive and immersive. To maintain the child's interest and attention, the illustrations change every 20-30 seconds.

Technology Stack

  • CSS3
  • Typescript
  • React.js
  • Vite
  • Mantine
  • TanStack

Setup & Installation

  1. Clone this repository to your local machine using https://github.com/Abyl10/samsung-front.git.
  2. Navigate to the project directory: cd samsung-front.
  3. Install project dependencies: yarn install.
  4. Run the app in the development mode: yarn start.
  5. Open http://localhost:3000 to view it in the browser.

Note: You might need to setup the backend for this app to fully function. Here's the backend repository: https://github.com/elamirKad/samsung-api.

How to Contribute

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution.

  1. Fork the Project.
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature).
  3. Commit your Changes (git commit -m 'Add some AmazingFeature').
  4. Push to the Branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/Abyl10/samsung-front

About

Frontend for the top-1 solution on the Samsung Innovation Hackathon

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published