Skip to content

saintsauceee/conuhacks-x

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ConuHacks X SAP Challenge - Lost & Found System

A lost and found management system built with modern web technologies. Users can report lost items, and administrators can scan QR codes to verify and manage item claims.

Project Overview

This is a full-stack application consisting of three main components:

  • API - Python/FastAPI backend with Gemini AI integration and Snowflake database
  • Client-User - Next.js user interface for reporting lost items
  • Client-Admin - Next.js admin interface for managing lost items and verifying users

Features

User Features

  • Report Lost Items - Upload photos and descriptions of lost items

Admin Features

  • Manage Items - View and manage all lost items in the system
  • User Verification - Confirm item claims

Technical Features

  • AI Integration - Gemini AI automatically generates item descriptions from images
  • Database - Snowflake integration for scalable data storage
  • Responsive Design - Mobile-friendly UI with Tailwind CSS

Getting Started

Setup Instructions

1. Clone the Repository

git clone <repository-url>
cd conuhacks-x

2. Setup API (Backend)

cd API

# Create virtual environment
python -m venv venv

# Activate virtual environment
# On Windows:
venv\Scripts\activate
# On macOS/Linux:
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

python main.py

3. Setup Client-User (User Interface)

cd client-user
npm install
npm run dev

4. Setup Client-Admin (Admin Interface)

cd client-admin
npm install
npm run dev

API Endpoints

Core Endpoints

  • POST /inquiries - Create a new lost item inquiry
  • GET /inquiries - Get all inquiries
  • GET /inquiries/{id} - Get specific inquiry
  • POST /gemini/generate-description - Generate AI description from image
  • POST /users - Create user account
  • POST /auth/login - User authentication

For full API documentation, see API README

Database

The system uses Snowflake for data storage. Key tables include:

  • Inquiries - Lost item reports
  • Users - User accounts
  • Verifications - Item verification records

For database setup, see Snowflake Setup

Environment Variables

API (.env)

DATABASE_URL=your_snowflake_url
GEMINI_API_KEY=your_gemini_key

Building for Production

Client-User

cd client-user
npm run build
npm start

Client-Admin

cd client-admin
npm run build
npm start

Key Technologies

  • Frontend: Next.js 16, React 19, TypeScript, Tailwind CSS
  • Backend: Python, FastAPI
  • Database: Snowflake
  • AI/ML: Google Gemini API

Client-User Routes

  • / - Home page (report lost item)

Client-Admin Routes

  • / - Dashboard
  • /scan - QR code scanner
  • /items - Manage items

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors