otion

🚀 Project Overview

Lotion provides slippery smooth notes supercharged by AI and AR. Our immersive platform combines Augmented Reality and Artificial Intelligence to make assisted learning available to all.

We came up with this idea when one of our teammates was studying for statistics before the beginning of the Hackathon. He realized that he was spending ages and ages navigating through the uncountable amounts of hopelessly long notes he had taken for his first exam.

Thus, we had the idea to create an AI powered note taking platform that classified, stored, and retrieved notes whenever you needed. Not only does it take away all the headache of searching through your notes by providing a note querying system based on your questions, it has an immersive AR based system that scans your homework to return the most relevant notes!

🌟 Features

• ✨ Note Classification: Automatically classifies and stores your handwritten or typed notes based on content and the classes you are taking
• 🚀 AR Note Annotations: Displays relevant notes based on scanned information in your camera
• 🔧 Note Querying: Returns relevant notes based on text input questions or statements
• 📈 Interactive Interface: Ease of access to all taken notes

🔧 Tools and Technologies

This project uses:

• Programming Languages:
  • Typescript, Python, JavaScript
• Frameworks and Libraries:
  • React Native, Expo, Flask, HuggingFace, Tailwind, Axios
• Database:
  • MongoDB, Firebase
• APIs Used:
  • Google Vision API, ChatGPT API

📦 Installation Guide

Follow these steps to set up the project locally.

1. Clone the Repository

To get a copy of the repository, run the following command:

git clone https://github.com/kgand/shellhacks2024.git

2. Navigate to the Project Directory

Change into the project's root directory:

cd shellhacks2024

🖥️ Frontend Setup

1. Navigate to the mobile Directory

Move into the front-end directory:

cd mobile

2. Install Dependencies

Install all required dependencies for the frontend:

npm install

3. Start the Development Server

Run the development server:

npm start

4. Begin Development

You can now begin developing the frontend.

🔙 Backend Setup

1. Navigate to the backend Directory

Move to the backend folder:

cd backend

2. Install Dependencies

Install the necessary Python packages:

pip install -r requirements.txt

3. Start the Backend Server

Run the backend application:

python app.py

4. Backend is Ready

The backend server should now be running, and you can begin backend development.

📝 Usage

Describe here how to use the application. You can provide example commands, screenshots, or video tutorials to help users understand how to use it effectively.

🙏 Acknowledgements

• Hugo Liu: Flask Backend, API Interfacing

📞 Contact

• Alexander Lou: https://www.linkedin.com/in/alexander-lou-uf/
• Alexander Wang: https://www.linkedin.com/in/alexanderwangy/
• Hugo Liu: https://www.linkedin.com/in/hugo-liu-dolphin/
• Kovidh Gandreti: https://www.linkedin.com/in/kovidhgandreti/

---

This is an open-source project. Contributions, feedback, and suggestions are highly appreciated!