https://github.com/maxonary/spotter
Share your location. Get real-time notifications of your favourite meme spots. AI analyses social media videos with reverse image search, puts them onto a map and enables users to get push-notified once they walk by a categorised spot.
https://github.com/maxonary/spotter
fastapi ios-swift streamlit
Last synced: 3 months ago
JSON representation
Share your location. Get real-time notifications of your favourite meme spots. AI analyses social media videos with reverse image search, puts them onto a map and enables users to get push-notified once they walk by a categorised spot.
- Host: GitHub
- URL: https://github.com/maxonary/spotter
- Owner: maxonary
- License: apache-2.0
- Created: 2025-01-18T10:47:26.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-09T06:47:24.000Z (over 1 year ago)
- Last Synced: 2025-02-09T07:25:28.858Z (over 1 year ago)
- Topics: fastapi, ios-swift, streamlit
- Language: Swift
- Homepage: https://meme-map.streamlit.app
- Size: 1.16 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Spotter - Redefine Sightseeing
Turn your digital memories into real-world moments. Share your location, and let Spotter do the rest. Our AI analyzes posts, videos, and images, mapping your digital memories to the places they were captured. As you move through the world, Spotter notifies you when you pass a meaningful spot, letting you relive, reconnect, and rediscover.
Spotter takes your digital life beyond the screen.
Let’s bring your memories to life.
---
## iOS App Overview
Spotter is a location-based app that allows users to discover and interact with links (e.g., memes, resources) on a map. The app integrates a FastAPI backend and a Streamlit frontend for a seamless user experience.
---
## Features
1. **Map View**: Display links on a map with markers, allowing users to explore links based on location.
2. **Link Management**: Add, update, and delete links with geolocation data and optional descriptions.
3. **Location-Based Notifications**: Receive notifications when nearby links are detected.
4. **Tabbed Interface**: Switch between different views, including a list of collected spots, a discover view, a friends view, and a me view.
---
## API and Map Overview
The Meme Map application is an interactive platform for geolocating and displaying links (e.g., memes, resources) on a map. It integrates a FastAPI backend and a Streamlit frontend for a seamless user experience. The application also supports MongoDB for database storage.
---
## Features
1. **FastAPI Backend**:
- Provides RESTful API endpoints for managing and querying geolocated links.
- Auto-generated Swagger documentation available at `/docs`.
2. **Streamlit Frontend**:
- Interactive web interface for adding, updating, and visualizing links on a map.
- Communicates with the FastAPI backend.
3. **MongoDB Integration**:
- Stores link information, geolocation data, and optional descriptions.
- Allows querying and filtering of stored links.
4. **Geocoding Support**:
- Converts street addresses to latitude and longitude coordinates using OpenStreetMap's Nominatim API.
5. **Interactive Map**:
- Displays stored links with markers.
- Allows users to explore links based on location.
---
## Installation
### Prerequisites
- Python 3.10 or higher.
- MongoDB instance (local or cloud-based).
- Node.js and npm (optional, for advanced development).
### Setup
1. **Clone the Repository:**
```bash
git clone https://github.com/yourusername/meme-map.git
cd meme-map
```
2. **Set Up the Environment:**
- Create a virtual environment:
```bash
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
```
- Install dependencies:
```bash
pip install -r requirements.txt
```
3. **Configure Secrets:**
- Create a `.env` file in the root directory with the following content:
```env
MONGO_URI=
```
- For Streamlit, configure `secrets.toml` in the `.streamlit` folder:
```toml
[default]
MONGO_URI = ""
```
4. **Run the Application:**
- Start the FastAPI server:
```bash
uvicorn api_meme_map:app --host 0.0.0.0 --port 8000
```
- Start the Streamlit frontend:
```bash
streamlit run meme_map.py
```
---
## Deployment
### Hosting FastAPI
- Use platforms like **Render**, **Railway**, or **Heroku** for hosting the FastAPI backend.
- Example `Procfile` for Heroku:
```
web: uvicorn api_meme_map:app --host 0.0.0.0 --port $PORT
```
### Hosting Streamlit
- Use **Streamlit Cloud** for deploying the frontend.
- Push your code to GitHub and link the repository to Streamlit Cloud.
---
## Usage
### FastAPI Endpoints
- **Swagger Documentation**: Navigate to `/docs` for auto-generated API documentation.
- **Key Endpoints**:
- `POST /add-or-update-link`: Add or update a link.
- `GET /all-links`: Fetch all stored links.
- `GET /nearby-links`: Fetch links within a specific radius.
- `DELETE /delete-link`: Delete a link by URL.
### Streamlit Features
1. Add a link with geolocation:
- Enter a valid URL, address, or coordinates.
- Provide an optional description.
2. View and interact with links on the map:
- Click markers to view link details.
- Filter links by location and distance.
---
## Contributing
1. Fork the repository.
2. Create a feature branch:
```bash
git checkout -b feature-name
```
3. Commit your changes:
```bash
git commit -m "Add feature description"
```
4. Push to the branch:
```bash
git push origin feature-name
```
5. Open a pull request.
---
## License
This project is licensed under the [Apache 2.0 License](LICENSE).
---
## Acknowledgments
- [Streamlit](https://streamlit.io/)
- [FastAPI](https://fastapi.tiangolo.com/)
- [MongoDB](https://www.mongodb.com/)
- [Nominatim API](https://nominatim.openstreetmap.org/)