HatchKeeper-Mobile is the mobile version of HatchKeeper, The
Free Open Source Egg Incubation Software. This version is written
in HTML5, CSS, and JavaScript.

HatchKeeper-Mobile (C) 2018-2023 by The HatchKeeper Team. See the
homepage at http://hatchkeeper.sourceforge.io for more information.

License

GNU GPL v3

Running In Browser

HatchKeeper-Mobile was written for Android. However since it is written
in HTML5, CSS, and JavaScript, it now supports running in most modern
browsers. There are certain limitaions such as no reminders, etc. Just
download the latest source, extract, and open index.html in your favorite
modern browser. It is recommended that you backup your HatchKeeper data
frequently since the database is stored in your browser's localStorage
and clearing your browser cache will clear batch data as well.

Building With Cordova

Although HatchKeeper-Mobile should build for most systems with very few
modifications, currently only Android is supported via
the Apache Cordova build system.

Building HatchKeeper Mobile requires a basic knowledge on setting up and
using Apache Cordova https://cordova.apache.org as well as Oracle JDK
and the Android SDK and build tools(Gradle).

Here are some tips:

Create a project folder with:

cordova create hatchkeeper-mobile com.hatchkeeperteam.hatchkeepermobile HatchKeeper-Mobile

A sample config.xml is provided with the source. You'll find it in the
Cordova folder.

You'll need to add these plugins:

cordova plugin add cordova-sqlite-storage 6.1.0
cordova plugin add cordova-clipboard
cordova plugin add cordova-plugin-file
cordova plugin add cordova-plugin-calendar
cordova plugin add cordova-plugin-save-dialog
cordova plugin add cordova-plugin-x-toast
cordova plugin add cordova-plugin-printer 
cordova plugin add cordova-plugin-androidx-adapter //Temp Shim For Printer Plugin

Copy the www folder from the source into to cordova project and replace
the existing www folder.

The icons are included in the Cordova/res/icon/android/ folder. These can be copied
into res/icon/android folder in the cordova project.

To remove the internet permission edit platforms/android/app/src/main/AndroidManifest.xml
and remove <uses-permission android:name="android.permission.INTERNET"></uses-permission>

Developer Documentation

You can generate developer documentation with the jsdoc tool. Install it
with:

sudo npm install -g jsdoc

Make doc directory

mkdir ./doc

then from the root of the source run:

jsdoc ./ -r  -d ./doc -R ./README.md

Open doc/index.html with your web browser. It's still very basic but
hopefully it'll give you a reference.

If you run into bugs, comments or questions please visit our disscusion
or tickets at http://hatchkeeper.sourceforge.io

Have Fun!

The HatchKeeper Team