| data | ||
| mod | ||
| .gitignore | ||
| app.py | ||
| brainstorm.txt | ||
| docker-compose.yml | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| requirements.txt | ||
POIFinder
POIFinder is a backend service that retrieves Points of Interest (POIs) based on a given geolocation.
Project Structure
POIFinder/
│
├─ app.py # Main entry point of the app
├─ Dockerfile # Docker configuration
├─ docker-compose.yml # Docker Compose configuration
├─ requirements.txt # Python dependencies
├─ README.md # Project overview
├─ brainstorm.txt # Developer chaotic notes
│
├─ data/ # Directory to store datasets
├─---- poi_data.json # Example data
│
└─ mods/ # Modular Python code
├─---- __init__.py
└─---- poi_module.py # Example module
Features
- Dockerized service
- Filter POIs based on geolocation, radius and type
- Modular structure for easy extension
How it works
app.pyserves as the main script.- The
mods/poi_module.pymodule contains all POI-related logic - Exposed service to 0.0.0.0:5720
Usage
Just build & start the container (docker compose required)
docker compose up -d --build
License
This project is licensed under the MIT License.
Data & External Services Disclaimer
POIFinder may retrieve, aggregate, or process data from third-party services (e.g. map providers, fuel station APIs, geolocation services).
Such data is NOT covered by this project's license and remains subject to the original licenses and terms of the respective providers.
Users of this software are responsible for ensuring compliance with any third-party data sources they integrate or query.