norkator / paketin-seuranta

Privacy preserving parcel tracking application for Android supporting multiple parcel courier companies. App is targeted in Finnish market. Standalone app, no private backends, tracking or overkill infrastructure. No ads or paid content.

Paketin Seuranta

Paketin Seuranta on pitkän historian omaava eri kuriirien toimitusten seuraamiseen tarkoitettu Android sovellus. Sovelluksen kohdeyleisö on Suomessa mutta pidetään repositorio yleisesti Englannin kielellä.

Paketin Seuranta is free application, no ads or paid content ever!

Table of contents

• Help required
• Development environment
  • Prerequisites
  • Installing
• Adding new courier
• For participants
• Versioning
• Author
• Contributors
• License

Help required

I am looking for help to develop this application further and maintain existing functionalities. If you are interested let me know, contact me via email: [email protected]

Development areas are: bug fixes, user interface, more tracking methods, better cleaner code and basic maintenance. Somebody with material design ui experience is especially welcome.

Anyone with less or more coding experience is welcome. Norkator moderates that any contribution will be respected so no need to be scared to contribute.

Android app: https://play.google.com/store/apps/details?id=com.nitramite.paketinseuranta

Dev environment

Prerequisites

• Download latest Android Studio
  • Follow it's normal installation instructions.

Installing

Steps to get development environment running

1. git clone https://github.com/norkator/paketin-seuranta.git or use gui like Github Desktop
2. Open Android studio
3. Click File -> Open -> Select project root containing app folder.
4. Download all required SDK etc files. Android Studio automatically installs all required packages.
5. Happy developing!

Adding new courier

Good sample PR of such case is #116

1. Creating parcel courier logos. I have been using following tool: https://romannurik.github.io/AndroidAssetStudio/icons-launcher.html
2. Add new courier strategy at /com.nitramite/courier folder. Use others existing ones as sample.
3. Add carrier with new id at CarrierUtils see others as sample. Use unique integer id! and add created icon.
4. Add carrier to UpdaterLogic class.
5. Add carrier to setCarrierSpinnerData at FragmentTrackedDelivery.
6. Add carrier to CarrierDetectorTask if you want this new carrier is part of automatic detection tool.
7. Should now be available for use.

For participants

1. Let's keep Paketin Seuranta simple and respect privacy.

2. No private servers /backends meaning only direct communication to parcel service provider apis.

3. I norkator will review and test pull requests. If everything looks and works according to rules pr will be merged. Otherwise I ask changes. Just give me time. This repo is not dead.

Versioning

We use Semver versioning

Given a version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when incompatible API changes are made,
MINOR version when backwards compatible features are added,
PATCH version when backwards compatible bug fixes are made.

Note that as a contributor you do not need to take versioning into account as the author Norkator is responsible of that.

Author

• Norkator - Initial work, code owner - norkator

Contributors

• Ristomatti Airo - Tons of ideas and project management
  • ristomatti
• Developer From Jokela - Code improvements, upgrades, Firebase Cloud Messaging integration
  • developerfromjokela
• CostelliGraphics - New app logo

License

MIT