An open API service indexing awesome lists of open source software.

https://github.com/erickogi/boreas


https://github.com/erickogi/boreas

Last synced: 18 days ago
JSON representation

Awesome Lists containing this project

README

          

# Boreas - Geocoding Platform

A modern React application showcasing advanced geocoding capabilities with autocomplete, forward geocoding, and reverse geocoding.

## Features

### **Tabbed Interface**
- Clean, organized UI with separate tabs for each geocoding method
- No clutter - focus on one feature at a time

### **Autocomplete Search**
- Real-time search suggestions as you type
- Country filtering (Uganda/Kenya)
- Debounced API calls for performance

### **Forward Geocoding**
- Convert addresses/place names to coordinates
- Country filtering support
- Confidence scores for result quality

### **Reverse Geocoding**
- Convert coordinates to addresses
- Country filtering
- "Use My Location" button (browser geolocation)
- Sample location shortcuts
- Distance-based ranking

### **Advanced Filtering**
- Toggle country filters on/off
- Uganda (UG) and Kenya (KE) support
- City-level filtering (requires boundary coordinates)

### **Enterprise Features**
- No API keys required
- Comprehensive location database
- High-performance geocoding

## Getting Started

```bash
# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build
```

## Geocoding API

Base URL: `https://calista.dev/api/pelias/v1/`

The application provides three main geocoding endpoints:
- `/autocomplete` - Real-time search suggestions
- `/search` - Forward geocoding (address → coordinates)
- `/reverse` - Reverse geocoding (coordinates → address)

### Priority & Ranking

See [PELIAS_PRIORITY_RANKING.md](./PELIAS_PRIORITY_RANKING.md) for detailed information on:
- How the system ranks and prioritizes results
- Handling duplicate place names across locations
- Using geographic focus and country filters
- Best practices for optimal results

## Technology Stack

- React 19
- TypeScript
- Vite
- Axios
- React Router

## Styling

Modern design system:
- Primary color: #2563EB (Blue)
- Clean, intuitive UI
- Mobile responsive