Skip to content

mohdlatif/FalconAI-Hackathon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 

Repository files navigation

LexiLeap 📚🚀

License: MIT Chrome Web Store Mobile App

LexiLeap is an innovative vocabulary learning tool designed for non-native English speakers. It seamlessly integrates into your daily web browsing experience, making language learning effortless and contextual.

🚀 Quick Start: Try the Extension

Follow these simple steps to test out the LexiLeap Chrome extension:

  1. Open your command prompt or terminal.

  2. Clone the repository by typing:

git clone git@github.com:mohdlatf/FalconAI-Hackathon.git

  1. Navigate to the cloned folder: cd FalconAI-Hackathon

  2. Open Google Chrome and go to chrome://extensions/

  3. Enable "Developer mode" in the top right corner.

  4. Drag and drop the extension folder from the FalconAI-Hackathon directory directly into the Chrome extensions page.

  5. You're all set! The LexiLeap extension should now be installed and ready to use.

🌟 Features

  • 🧠 AI-powered definitions and examples
  • 🖱️ One-click word saving
  • 🔍 Automatic word highlighting across websites
  • 💡 Hover-over functionality for quick meaning recall
  • 👤 Personalized word banks

🏗️ Project Structure

The project consists of three main components:

  1. 🌐 Chrome Extension
  2. 📱 Mobile App
  3. 🖥️ Backend Server

Chrome Extension 🌐

The Chrome extension is the core component of LexiLeap. It allows users to interact with web pages, save words, and view definitions.

Setup

  1. Navigate to the extension folder
  2. Load the extension in Chrome from the extension folder

Mobile App 📱

The mobile app provides on-the-go access to saved words and definitions.

Note: The mobile app was challenging to implement, but we managed to create a functional version. It may have limited features compared to the Chrome extension.

Setup

  1. Navigate to the mobile-app folder
  2. Install dependencies: npm install
  3. Run the app:
    • For Android: npx react-native run-android
    • For iOS: npx react-native run-ios

Backend Server 🖥️

The backend server handles user authentication, stores user data, and serves AI-generated definitions.

Setup

  1. Navigate to the backend folder
  2. Install dependencies: npm install
  3. Set up environment variables (see .env.example)
  4. Start the server: npm start

About

An innovative AI project leveraging Falcon LLM for the Falcon Hackathon 2024

Resources

Stars

Watchers

Forks

Contributors