Skip to content

Importantus/location-share

Repository files navigation

The logo of the location share app

Location Share

Simple and reliable location sharing.

GitHub Actions Workflow Status GitHub release (latest by date) GitHub

Warning

This app is still under heavy development and not ready for production use!

Location Share is a simple app that allows you to share your location with your friends and family. It is designed to be easy to use, yet open and reliable. The app is built with Jetpack Compose and uses a self-hostable server written in Go for the backend.

A mockup of the location share app

Why Location Share?

Your location is among your most sensitive data and you should be in control of it. Existing location sharing apps often require you to create an account and share your data with a third party. Location Share is designed to be self-hosted, meaning you can run your own server and be in control of your data.

Being in control of your own data also means that you can do with it whatever you want. The API is open and easy to use, so you can build your own clients, dashboards, run data analysis on your location data, or even integrate it with your smart home.

What does reliable mean?

As this is just a side project and I am the only developer, I can't guarantee that the app will be updated regularly or be bug-free. However, by reliable, I mean that when you share your location with someone, you want them to always have the latest location. This is why I use the same trick as Google Maps: The app sends a push notification to the device to wake it up and fetch the latest location.

Development

Release

When you want to create a new release, follow these steps:

  1. Update the versionName (e.g. 1.2.3) and increase the versionCode (e.g. 3) in app/build.gradle.kts
  2. Commit that change (git commit -am v1.2.3)
  3. Tag the commit (git tag v1.2.3). Make sure your tag name's format is v*.*.*
  4. Push the changes to GitHub (git push && git push --tags)
  5. Edit and publish the release draft created by the workflow in GitHub

After building successfully, the action will publish the release artifacts in a new release draft that will be created on GitHub with download links for the app.

Contributing

I am happy about every contribution to this project. If you have an idea for a new feature, found a bug, or just want to help out, feel free to open an issue or a pull request. Please make sure to use the gitmoji convention for your commit messages.

Thanks

This project would not be possible without the following projects:

  • Ramani Maps for the just simple enough compose-wrapper around Maplibre
  • Versatiles for the best tile server (and much more) out there
  • Lucide for the beautiful icons

About

Simple and reliable location sharing

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages