Skip to content

Add documentation about how to use an offline map #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicopace merged 1 commit into from
Aug 13, 2025
Merged

Add documentation about how to use an offline map #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,24 @@ For production environments like Azure, input the environmental variables via th

**Port:** Specify a port to serve the app. Default is 8080.

## How to use the outputs

Once the map request is completed, the user can download the offline map file, or scan a QR code to share a link to download the file.

The offline map file will be in either [MBTiles](https://wiki.openstreetmap.org/wiki/MBTiles) or [Styled Map Package](https://github.com/digidem/styled-map-package) format.

MBTiles can be used in a variety of applications to serve as a background map, including:

- [ODK Collect](https://getodk.org/)
- [Kobo Collect](https://www.kobotoolbox.org/)
- [Locus Map](https://www.locusmap.app/)

Styled Map Packages can be used in:

- [CoMapeo](https://comapeo.app/)

Please refer to the documentation for each application to learn how to import the offline map file.

## Build Setup

```bash
Expand Down