Building from Source

Building from Source

git clone https://github.com/anand34577/lekhamint.git
cd lekhamint

Part	Folder	Needs
Server	server/	Go 1.26+ (and make)
Web app	web/	Node.js 20+
Android app	android/	JDK 17 and the Android SDK (API 36)

Server

cd server
make demo        # run with a year of sample data: http://localhost:8080, demo@example.com / demo1234
make run         # run with your own data in ./data
make test        # all tests; set LEKHAMINT_TEST_PG_DSN to a PostgreSQL URL to test that too
make build       # dist/lekhamint
make release     # dist/lekhamint-<os>-<arch> for every platform

The binary has no C dependencies (the SQLite driver is pure Go), so cross-compiling just works.

Web app

cd web
npm ci
npm run dev      # http://localhost:5173, talks to a server on :8080 (run `make demo` in server/)
npm test

The server embeds the built web app from server/internal/webui/dist. After changing web/, run make web in server/ to rebuild and embed it.

The online demo is the web app plus the server compiled to WebAssembly: make demo-site in server/ writes it to web/dist-demo/. Serve that folder with any static file server.

Android app

cd android
./gradlew testDebugUnitTest      # unit tests
./gradlew assembleDebug          # app/build/outputs/apk/debug/app-debug.apk
./gradlew connectedDebugAndroidTest   # on an emulator or device

Release builds are signed with the key from android/keystore.properties (ignored by git):

storeFile=release.jks
storePassword=…
keyAlias=…
keyPassword=…

or from the environment variables ANDROID_KEYSTORE_FILE, ANDROID_KEYSTORE_PASSWORD, ANDROID_KEY_ALIAS and ANDROID_KEY_PASSWORD. Without a key the release build uses the debug key, which is fine for testing.

Docker image

docker build -t lekhamint .

Releases

Pushing a tag such as v1.2.0 makes GitHub Actions build the signed APK, the server for every platform and the multi-arch Docker image, and publish them with release notes from CHANGELOG.md. The repository needs the secrets ANDROID_KEYSTORE_BASE64 (base64 -w0 release.jks), ANDROID_KEYSTORE_PASSWORD, ANDROID_KEY_ALIAS and ANDROID_KEY_PASSWORD.

Design documents

The docs/ folder explains the product, the money rules, the architecture, the data model, the sync protocol and the API in depth. Contributions are welcome: see CONTRIBUTING.md.