Skip to content

๐Ÿ“– Web3 AI Learning Platform that transcends book experiences (Built with Juno & ICP)

License

Notifications You must be signed in to change notification settings

raite-hackathon-2024/read-with-me

Repository files navigation

ReadWithMe: Unlocking Literacy in Young Minds


๐ŸŒŸ What is ReadWithMe?

ReadWithMe is an AI-powered learning platform that gamifies how students read books to improve their reading comprehension. Through various gaming activities, engaging challenges, personalized feedback, and adaptive difficulty levels, ReadWithMe transforms the reading experience into an interactive and motivating learning process! ๐ŸŽฎ๐Ÿ“–

Our platform uses advanced natural language processing to generate relevant questions about the books students are reading. These questions range from basic comprehension checks to more complex analytical inquiries, encouraging students to think critically about the text they're studying. ๐Ÿค”๐Ÿ’ก

๐ŸŽฏ What is it for?

ReadWithMe aims to address the literacy challenges faced by young learners, particularly in the Philippines. By using gamification and adaptive learning technologies, we make reading comprehension more engaging and accessible, ultimately helping students improve their skills in an enjoyable way. ๐Ÿ‡ต๐Ÿ‡ญ๐Ÿ“ˆ

We're solving the problems of:

  • Low literacy rates ๐Ÿ“‰
  • Lack of interest in reading ๐Ÿ˜ด
  • Limited access to educational tools ๐Ÿšซ

By providing a scalable, interactive, and user-friendly platform! ๐Ÿš€

View the pitch deck ๐Ÿ“ˆ

Watch the walkthrough video ๐Ÿ’ป

๐Ÿ” How it works?

Read With Me (How It Works)

๐Ÿ“ธ Screenshots

Screenshot 2024-10-21 at 22-25-43 Read With Me! Screenshot 2024-10-21 at 22-26-27 Read With Me! Screenshot 2024-10-21 at 22-26-39 Read With Me! Screenshot 2024-10-21 at 22-27-08 Read With Me! Screenshot 2024-10-21 at 22-27-58 Read With Me!

๐Ÿ› ๏ธ Setup Instructions

Prerequisites:

  • NPM/Yarn ๐Ÿ“ฆ
  • Docker Desktop ๐Ÿณ
  • Juno CLI ๐Ÿ›ฐ๏ธ

How to run?

  1. Install dependencies: npm install
  2. Install Juno CLI: npm i -g @junobuild/cli
  3. Open Docker Desktop (if not installed, download from here) For Macs, a lightweight alternative is Orbstack
  4. Create and run the Docker container for the website: juno dev start
  5. In another terminal, run the website for testing: npm run dev
  6. To allow sharing the website on LAN: npm run dev -- --host
  7. Note: At first visit, there's a security warning because it uses HTTPS without a certificate. You can safely ignore it as it's only used to make the camera functionality work in LAN, especially on mobile.

๐ŸŒ How to deploy to the mainnet?

  1. Create a satellite in the Juno console
  2. Open a terminal and login to the Juno CLI: juno login
  3. On the root of your project, open a terminal and build your project for deployment: npm run build
  4. Once your website is built (check for dist or build folder), then deploy your website to Juno: juno deploy
  5. To open your website, run: juno open (You can also go to the Juno console to view the canister URL)

Deployed Canister URL:

https://nh5bg-raaaa-aaaal-amqbq-cai.icp0.io

๐Ÿš€ Technologies Used

  • Juno - Blockchain-as-a-service platform for deploying dapps onto ICP ๐ŸงŠ
  • React - Front-end JavaScript library โš›๏ธ
  • Vite - Modern, fast build tool and development server โšก
  • Zustand - Small, fast, and scalable state management solution ๐Ÿป
  • react-camera-pro - Universal Camera component for React ๐Ÿ“ท
  • Tesseract.js - OCR engine for JavaScript ๐Ÿ‘๏ธ
  • HuggingFace - Platform to easily access machine learning models for various tasks ๐Ÿค—
  • Mistral AI - Advanced AI for natural language processing tasks ๐Ÿง 
  • ChatGPT - OpenAI's large language model designed for chatbots ๐Ÿค–
  • ElevenLabs - Text-to-speech AI platform ๐ŸŽ™๏ธ
  • Tailwind CSS - Utility-first CSS framework ๐ŸŒˆ
  • Mantine UI - React components library ๐Ÿงฑ

๐Ÿ—๏ธ Architecture

Read With Me (Architecture)

๐Ÿ‘ฅ Team Members

  • Mel Mathew Palaรฑa - Project Manager, DevOps Engineer, Database Administrator, Full-stack Developer ๐Ÿ‘จโ€๐Ÿ’ป
  • Jose Gabriel Cruz - Lead UI/UX Designer, Frontend Developer, Presenter ๐ŸŽจ
  • John Carlo Paz - UI/UX Designer, Frontend Developer ๐Ÿ–Œ๏ธ
  • Quiana Dayrit - Business Analyst, Content Manager, Presenter ๐Ÿ“Š

๐Ÿ™ Acknowledgements

We would like to express our heartfelt gratitude to:

  • Systems Plus College Foundation ๐Ÿซ - For providing us with the educational foundation and resources necessary to bring this project to life.
  • ICTDU (Information and Communications Technology Development Unit) ๐Ÿ’ป - For their unwavering support and guidance throughout every step of our journey.

Your belief in our potential and your continuous assistance have been instrumental in making ReadWithMe a reality. Thank you for giving us this incredible opportunity to make a difference in the field of education and literacy. ๐ŸŒŸ

๐Ÿ“œ License

This project is licensed under the MIT license, see LICENSE.md for details.

About

๐Ÿ“– Web3 AI Learning Platform that transcends book experiences (Built with Juno & ICP)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published