Skip to content

Akylas/mbview-rs

Repository files navigation

MBTiles Viewer, a cross-platform MBTiles Viewer.

Windows Support Ubuntu Support Arch Linux Support Windows Support


What is MBTiles Viewer?

Demo

MBTiles Viewer is a tool to view and inspect mbtiles files without the need of running a docker or a web server

  • 100% offline
  • load vector mbtiles
    • See all layers
    • hide/show layers
    • filter lines/polygons/points
    • click or shift+move to inspect map elements
    • bottom panel to view features details
  • load raster mbtiles
  • load multiple mbtiles on the same map
  • split feature to view/compare mbtiles side by side
  • multiple themes
  • localized (fr/en for now)

You can give your suggestions and feedback on our Discussions page. If you feel comfortable in writing code using Typescript and Rust, we highly encourage you to contribute to this project.


Project Roadmap

Recommend us a feature by opening an Discussion if you'd like to.


Installation

If you want to install on your system, you can download the installer for your operating system on the release page.


Bug Reporting

If you find any bugs, please report it by submitting an issue on our issue page with a detailed explanation. Giving some screenshots would also be very helpful.

Feature Request

You can also submit a feature request on our issue page or discussions and we will try to implement it as soon as possible. If you want to contribute to this project, please contribute to this project.


Development

If you want to run this project in your local system, please follow this guide:

  1. Fork this project

  2. Clone the project to your local system using this command

  3. Follow this guide to set up Tauri environment

$ git clone https://github.com/<your_github_username>/mbview-rs.git
  1. Change directory to the root directory of this project
$ cd mbview-rs
  1. Install all dependencies using pnpm or yarn
$ pnpm install
  1. Run the project in development mode. Please note that it might takes some times for Cargo to install dependencies for the first run.
$ pnpm dev

Contribution Guide

We highly encourage you to contribute to this project (even if you are a beginner). And if you finally want to contribute to this project, please read our contribution guide.


LICENSE

Apache-2.0