|
|
||
|---|---|---|
| .github | ||
| docs | ||
| FloconAndroid | ||
| FloconDesktop | ||
| .gitignore | ||
| LICENSE | ||
| mkdocs.yml | ||
| README.md | ||
Flocon is an advanced debugging and inspection tool built with Kotlin Multiplatform (KMP), designed to work seamlessly across Android and desktop environments.
Inspired from Flipper by Meta, while leveraging modern Kotlin multiplatform architecture for networking, databases, analytics, and UI data visualization.
It allows developers to connect a Kotlin Multiplatform or Android app to their computer and launch a desktop interface that can observe, inspect, and interact with the running app in real time — across shared Kotlin code and platform-specific implementations.
Getting Started
This library is lightweight, contributing just 140KB to the overall app size
in your module .kts
debugImplementation("io.github.openflocon:flocon:LAST_VERSION")
releaseImplementation("io.github.openflocon:flocon-no-op:LAST_VERSION")
in your Application.kt
// android initialization
Flocon.initialize(this)
// desktop / ios
Flocon.initialize()
[versions]
flocon = "LASTEST_VERSION"
[libraries]
flocon = { module = "io.github.openflocon:flocon", version.ref = "flocon" }
📖 Documentation
Visit the full documentation site for setup guides, feature details, and advanced usage:
👉 openflocon.github.io/Flocon/
Table of Contents
✨ Features at a Glance
| Feature | Android | KMP (JVM/iOS) |
|---|---|---|
| Network (HTTP/Mocking) | ✅ | ✅ |
| Database (Room/SQLite) | ✅ | ✅ |
| Preferences | ✅ | ❌ |
| Dashboards & Tables | ✅ | ✅ |
| Analytics & Images | ✅ | ✅ |
| Deeplink & Files | ✅ | ❌ |
🧰 Requirements
- Android: Device/Emulator with USB debugging + ADB.
- KMP: Kotlin 2.0.0+ in your app.
- Desktop: Flocon Desktop app (JVM-based).
For detailed platform-specific requirements, see the Setup Guide.
🤝 Contributors
Thanks to these amazing people for making Flocon better every day!
License
Flocon is MIT licensed, as found in the LICENSE file.