README.md 4.18 KB
Newer Older
Thomas's avatar
Thomas committed
1
# MediLog
2
![MediLog](./app/src/main/ic_launcher.png)
Thomas Zell's avatar
Thomas Zell committed
3

Thomas Zell's avatar
Thomas Zell committed
4
Android App to easily capture blood pressure and body weight
Thomas Zell's avatar
Thomas Zell committed
5

6
**Note: If you are upgrading from versions < 1.5 please make sure you export your data first. V 1.5 will create a new database!**
Thomas Zell's avatar
Thomas Zell committed
7

Thomas Zell's avatar
Thomas Zell committed
8
## Key features
Thomas Zell's avatar
Thomas Zell committed
9

Thomas Zell's avatar
Thomas Zell committed
10 11 12
### Tracker free
I wrote this app because I don't want to hand over my health data to any tracking company out there, but also because I wanted to learn how to write an app for Android. Have a look at the result and tell me if I acomplished my goal :-)
In any case, no telemetry, no crash logs or anything similar is sent to anyone.
13

Thomas Zell's avatar
Thomas Zell committed
14
### Manual data entry
Thomas Zell's avatar
Thomas Zell committed
15 16
Data input is purposely kept to manual, but aimed to make entry as quick and simple as possible. 
I have no intention to add links to wifi/bluetooth enabled measurement devices as these will introduce 3rd parties one doesn't control. 
Thomas Zell's avatar
Thomas Zell committed
17 18 19 20

### Data export
Data can be imported and exported for backup and transfer reasons. File format is CSV which is understood by almost any application which works with structured data. E.g. Excel, LibreOffice Calc, databases, etc.

Thomas Zell's avatar
Thomas Zell committed
21 22
The app allows to create PDF reports to print/share with your doctor/medical staff. 
Be aware that this is sensitive data, so please handle with due care and enable password protection / encryption for the exported files.
Thomas Zell's avatar
Thomas Zell committed
23 24

### Multi language
Thomas Zell's avatar
Thomas Zell committed
25
Currently the app supports English and German, if someone volunteers as translator, more languages can be added
Thomas Zell's avatar
Thomas Zell committed
26 27

### Installation
Thomas Zell's avatar
Thomas Zell committed
28 29 30 31 32 33

[<img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png"
     alt="Get it on F-Droid"
     height="80">](https://f-droid.org/packages/com.zell_mbc.medilog/)

From my website: https://zell-mbc.com/documents/app-release.apk
Thomas Zell's avatar
Thomas Zell committed
34

Thomas Zell's avatar
Thomas Zell committed
35
Or clone and compile from here
Thomas Zell's avatar
Thomas Zell committed
36 37 38 39 40 41

### Removal
Like with all Android applications, via a long click on the app icon.


**Uninstalling the application will delete the database! Unrecoverable! Make sure you export your data first!**
42

Thomas Zell's avatar
Thomas Zell committed
43

44 45
## Privacy Policy

Thomas Zell's avatar
Thomas Zell committed
46
### Stored data
Thomas Zell's avatar
Thomas Zell committed
47
Data entered by the user is stored inside an encrypted (v.1.7.5+) SQLite database. 
48

Thomas Zell's avatar
Thomas Zell committed
49
**To keep the input process as simple and fast as possible, the app/your data is not protected with an additional password. If your device has support for Biometric (Fingerprint) make sure to enable it. Otherwise, if someone is able to unlock your device they can access your health data!**
50

Thomas Zell's avatar
Thomas Zell committed
51 52
The app supports storing backups in encrypted ZIP files. Make sure you turn encryption on by setting a ZIP password in the settings dialog. Make sure you remember the password.
The app allows to send protected files so you can share over unprotected media (eg. email) without the risk of your data getting in the wrong hands.
53

Thomas Zell's avatar
Thomas Zell committed
54

Thomas Zell's avatar
Thomas Zell committed
55
### Required permissions
56

Thomas Zell's avatar
Thomas Zell committed
57 58
- WRITE_EXTERNAL_STORAGE : Required to export CSV backup files
- READ_EXTERNAL_STORAGE : Required to import CSV files
59 60 61 62 63


### Tracking and Libraries
This application does not use any tracking tools and does not run advertising.

Thomas Zell's avatar
Thomas Zell committed
64 65
3rd party libraries used are the below:

66
- AndroidPlot: For the charts
Thomas Zell's avatar
Thomas Zell committed
67
- Takisoft.fix: To fix an Android preference dialog bug.
Thomas Zell's avatar
Thomas Zell committed
68 69
- Zip4J: For handling password protected ZIP files
- SQLCipher: To encrypt the SQLite database
70

Thomas Zell's avatar
Thomas Zell committed
71
## Contact
72 73 74 75 76

- Matrix: #medilog:zell-mbc.com
- eMail: [email protected]

## Languages
77

78 79
- English
- German
80 81

## Donations
Thomas Zell's avatar
Thomas Zell committed
82
If you feel like it…
83

Thomas Zell's avatar
Thomas Zell committed
84 85
[<img src="https://www.paypalobjects.com/webstatic/de_DE/i/de-pp-logo-100px.png" border="0"
    alt="PayPal Logo">](https://www.paypal.com/paypalme/thomaszellmbc)
Thomas Zell's avatar
New:  
Thomas Zell committed
86

Thomas Zell's avatar
Thomas Zell committed
87
[<img src="https://upload.wikimedia.org/wikipedia/commons/thumb/c/c5/Bitcoin_logo.svg/252px-Bitcoin_logo.svg.png" border="0"
88
height="20" alt="Bitcoin Logo">](https://live.blockcypher.com/btc/address/1EUrRpjDAGgpS8J46tmsVWKbgNqAv7rWC7/)
Thomas Zell's avatar
New:  
Thomas Zell committed
89 90


Thomas Zell's avatar
Thomas Zell committed
91
## Screenshots
Thomas Zell's avatar
Thomas Zell committed
92 93 94 95 96 97 98
![image](fastlane/metadata/android/en-US/images/phoneScreenshots/list1.png)
![image](fastlane/metadata/android/en-US/images/phoneScreenshots/list2.png)
![image](fastlane/metadata/android/en-US/images/phoneScreenshots/chart1.png)
![image](fastlane/metadata/android/en-US/images/phoneScreenshots/chart2.png)
![image](fastlane/metadata/android/en-US/images/phoneScreenshots/Settings.png)
![image](fastlane/metadata/android/en-US/images/phoneScreenshots/About.png)
![image](fastlane/metadata/android/en-US/images/phoneScreenshots/PDFReport.png)
Thomas Zell's avatar
Thomas Zell committed
99

Thomas Zell's avatar
Thomas Zell committed
100
## Changelog
Thomas Zell's avatar
Thomas Zell committed
101
[Change log](ChangeLog.md)
Thomas Zell's avatar
Thomas Zell committed
102

103