map-offline-navigation

KO | EN

gitlite — search

#go #rust #linux #nodejs #windows #awesome #cli #kubernetes #vue #awesome-list #security #pytorch #mcp #open-source

map-offline-navigation

(★ 10)

Kblack: Offline Android navigation with GraphHopper & MapLibre.

map-offline-navigation Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">Kblack: Offline Map Navigation (MVP)</h1>

<p align="center">
  <strong>Kblack: Offline Map Navigation is an offline navigation app for Android that utilizes the GraphHopper library for routing algorithms and MapLibre for map rendering.</strong>
</p>

<p align="center">
  <strong>⚠️ Currently only supports Vietnam.</strong>
  Want your region? <a href="https://github.com/khoa083/map-offline-navigation/issues">Open an issue →</a>
</p>

## Screenshots

## Features

* View maps and route directions completely offline. 
* Download via WorkManager with HTTP-Range support 
* Compress directories in tar.zst format to reduce size. 
* Supports rotate, zoom, and 2D/3D compass mode toggles. 
* Auto-recalculate route when off track (> 30m deviation). 
* Supports car, motorcycle profiles, foot. 
* POI search (Hybrid Approach, SSOT, Search Vector). 
* In-app updates.
  
## Project Status

## Credits

* [GraphHopper](https://www.graphhopper.com/) for the routing engine.
* [MapLibre](https://maplibre.org/) for the map rendering library.
* [OpenStreetMap](https://www.openstreetmap.org/) contributors for the map data.
* [OpenFreeMap](https://openfreemap.org/) for the map tile hosting and styles.
* This project is referenced from and inspired by [PocketMaps](https://github.com/junjunguo/PocketMaps) by [junjunguo](https://github.com/junjunguo). It has been modernized and completely rewritten using **Clean Architecture**, **MVVM**, **Kotlin**, and **Jetpack Compose**.
* [Photon](https://photon.komoot.io/) for the POI and geocoding search API.

## Architecture

The project is built with **Clean Architecture** and follows the **MVVM (Model-View-ViewModel)** pattern to ensure scalability, maintainability, and ease of testing.

* **UI Components**:
    * **Jetpack Compose** (Declarative UI)
    * **Material Design 3**
* **Dependency Injection**: Hilt
* **Asynchronous Processing**: Coroutines & Flow
* **Navigation**: Navigation Compose
* **Local Data**: Room Database & DataStore (Preferences)
* **Remote Data**: Retrofit 2 + OkHttp + Moshi (JSON)
* **Routing Engine**: GraphHopper
* **Map Rendering**: MapLibre Compose
* **Other Libraries**:
    * **WorkManager**: Background tasks processing
    * **Timber**: Advanced logging
    * **Chucker**: In-app HTTP inspection (Debug)
    * **LeakCanary**: Memory leak detection
    * **Konfetti**: Particle system for celebratory effects
    * **Commonmark**: Markdown rendering support

## Build

### Requirements

* [Android Studio](https://developer.android.com/studio)
* Java 21 or higher

### Steps

1. Clone the repository:
   ```bash
   git clone https://github.com/khoa083/map-offline-navigation.git
   cd map-offline-navigation 
   ```
2. Open the project in Android Studio

3. Sync Gradle and run the app on a device or emulator

### Running tests

* Run all unit tests:

```bash
./gradlew :app:testDebugUnitTest
```

> **Note:** After execution, the HTML report can be found at:  
> `app/build/reports/tests/testDebugUnitTest/index.html`
<img width="500" alt="image" src="https://github.com/user-attachments/assets/8f607d65-8b50-494c-bcdb-a061008649d4" />

* Run Jacoco:

```bash
./gradlew :app:jacocoTestReportAll
```

> **Note:** After execution, the HTML report can be found at:  
> `app/build/reports/jacoco/all/html/index.html`

## Contributing
Pull requests and issue reports are welcome. Help us improve Kblack: Offline Map Navigation!

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

map-offline-navigation

map-offline-navigation Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

map-offline-navigation

map-offline-navigation Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README