https://github.com/aye-shadow/cust-hackathon
https://github.com/aye-shadow/cust-hackathon
llm python rag streamlit
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/aye-shadow/cust-hackathon
- Owner: aye-shadow
- License: mit
- Created: 2025-05-16T07:29:14.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-18T08:45:11.000Z (about 1 year ago)
- Last Synced: 2025-08-10T06:39:50.650Z (11 months ago)
- Topics: llm, python, rag, streamlit
- Language: Python
- Homepage: https://cust-hackathon-hzivsv4bjikgyweyv6a8pt.streamlit.app/
- Size: 2.77 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BioScout - Biodiversity Tracking Application
BioScout is a modern web application for tracking and monitoring local biodiversity. It allows users to submit wildlife observations, view sightings on an interactive map, and get AI-powered answers about local biodiversity.
## Features
### 1. Submit Observations
- Upload images of wildlife sightings
- Automatic species identification using AI
- Interactive map for precise location marking
- Detailed form for recording:
- Date of observation
- Location coordinates (with visual confirmation)
- Location description
- Additional notes
- Real-time feedback and validation
### 2. View Observations
- Grid and map view options
- Filter observations by species type:
- Birds
- Mammals
- Plants
- Amphibians
- Reptiles
- Insects
- Up to 50 recent sightings per species type
- Interactive markers on map view
- Detailed observation cards with images
### 3. Ask Questions
- AI-powered Q&A about local biodiversity
- Example questions provided
- Detailed answers with source citations
- Focus on local wildlife and conservation
## Technical Stack
### Frontend
- React with TypeScript
- Material-UI (MUI) for components
- Custom nature-inspired theme
- Leaflet for interactive maps
- Responsive design for all devices
### Backend
- FastAPI
- Image processing and storage
- CSV-based data management
- Species identification AI integration
## Theme Design
The application features a bio-inspired design with:
- Rich forest greens and honey amber colors
- Subtle gradients and animations
- Organic shapes and decorative elements
- Custom styled components:
- Cards with gradient borders
- Light green buttons with hover effects
- Frosted glass navigation bar
- Custom form inputs with shadows
- Nature-themed icons
## Setup Instructions
1. Clone the repository:
```bash
git clone [repository-url]
cd bioscout
```
2. Install backend dependencies:
```bash
cd backend
pip install -r requirements.txt
```
3. Install frontend dependencies:
```bash
cd frontend/bioscout-ui
npm install
```
4. Start the backend server:
```bash
cd backend
uvicorn main:app --reload
```
5. Start the frontend development server:
```bash
cd frontend/bioscout-ui
npm start
```
The application will be available at `http://localhost:3000`
## Data Management
- Observations are stored in CSV files by species type
- Images are stored in `data/sightings/images`
- Data can be reset using the cleanup process
## Contributing
1. Fork the repository
2. Create a feature branch
3. Commit your changes
4. Push to the branch
5. Create a Pull Request
## License
This project is licensed under the MIT License - see the LICENSE file for details.