Developer Guide

Ready to contribute or build your own version of Sinkhole? This guide covers everything you need to know about setting up the development environment and generating APKs.

Prerequisites

Node.js: Latest LTS version.
Java SDK (JDK): OpenJDK 17 (Microsoft Build recommended for Windows).
Android Studio: For SDK management and emulators.

Setup Process

# 1. Clone the repository
git clone https://github.com/thiagocolen/sinkhole.git
cd sinkhole

# 2. Install dependencies
npm install

Building the App

Depending on your goal, you can run Sinkhole in debug mode or generate a final release APK.

Debug Mode: (Runs on device/emulator with Dev Tools)

npx expo run:android

Release Build: (Standalone optimized APK)

npm run build:apk

The resulting APK will be located at: android/app/build/outputs/apk/release/app-release.apk.