How esha-05/fuel-route-project works
Fuel Route Planner is a Django REST API that accepts US origin and destination locations and returns a driving route, fuel-stop recommendations, and trip fuel totals. The principal workflow validates the request, geocodes both endpoints, obtains route geometry and distance, then plans stops using nearby station prices. Fuel data uses the provided station-price CSV and US city coordinates. The README also describes station geocoding as disk-cached, but the sampled implementation shows in-memory station caching; the cache mechanism is therefore not represented as a separate component.
Main entry points: views.py Route endpoint · geocoder.py Location geocoder · fuel_data.py Station lookup · osrm_client.py OSRM client
Components 12
API
- Route endpoint
fuel_route_project/route_planner/views.py - Request validation
fuel_route_project/route_planner/serializers.py
Location lookup
- Location geocoder
fuel_route_project/route_planner/geocoder.py - City coordinates
fuel_route_project/uscities.csv
Route lookup
- OSRM client
fuel_route_project/route_planner/osrm_client.py
Fuel planning
- Stop optimizer
fuel_route_project/route_planner/route_optimizer.py - Station lookup
fuel_route_project/route_planner/fuel_data.py - Fuel prices
fuel_route_project/fuel_prices.csv
Other components
- API client
- Photon API
- Nominatim API
- OSRM routing
Connections 11
- API client → Route endpoint: requests route
README.md - Route endpoint → Request validation: validates input
fuel_route_project/route_planner/views.py - Route endpoint → Location geocoder: geocodes endpoints
fuel_route_project/route_planner/views.py - Location geocoder → Photon API: queries first
fuel_route_project/route_planner/geocoder.py - Location geocoder → Nominatim API: falls back to
fuel_route_project/route_planner/geocoder.py - Route endpoint → OSRM client: requests route
fuel_route_project/route_planner/views.py - OSRM client → OSRM routing: fetches geometry
fuel_route_project/route_planner/osrm_client.py - Route endpoint → Stop optimizer: plans fuel stops
fuel_route_project/route_planner/views.py - Stop optimizer → Station lookup: searches nearby
fuel_route_project/route_planner/route_optimizer.py - Station lookup → City coordinates: resolves city coordinates
fuel_route_project/route_planner/fuel_data.py - Station lookup → Fuel prices: loads station prices
fuel_route_project/route_planner/fuel_data.py