Skip to content

Getting Started with DevView

Welcome to DevView! This guide will help you get up and running with the framework in your Kotlin Multiplatform project.

Prerequisites

Before you begin, make sure you have:

  • ✅ Kotlin Multiplatform Project – A working KMP project targeting Android and/or iOS
  • ✅ Compose Multiplatform – Compose Multiplatform configured in your project
  • ✅ Minimum Versions:
    • Kotlin 2.4.0+
    • Compose Multiplatform 1.11.1+
    • Android: API 26 (Oreo) or higher
    • iOS: iOS 16.0 or higher

Setup Overview

Setting up DevView involves three main steps:

  1. Installation – Add dependencies to your project
  2. Quick Start – Integrate DevView into your app
  3. Configuration – Customise modules and settings

What You'll Learn

Installation

Learn how to add DevView dependencies to your Gradle configuration for both shared and platform-specific code.

Go to Installation →

Quick Start

Follow a step-by-step tutorial to integrate DevView into your application with working code examples.

Go to Quick Start →

Configuration

Discover advanced configuration options, module selection, and customisation techniques.

Go to Configuration →

Quick Preview

Here's a minimal example of what DevView integration looks like (including all core modules):

@Composable
fun App() {
    var isDevViewOpen by remember { mutableStateOf(false) }
    val modules = rememberModules {
        module(FeatureFlip)
        module(Analytics)
        module(NetworkMock)
    }
    Box {
        MainAppContent()
        DevView(
            devViewIsOpen = isDevViewOpen,
            closeDevView = { isDevViewOpen = false },
            modules = modules
        )
    }
}

Tip: Start with the core modules (FeatureFlip, Analytics, NetworkMock) and add custom modules as your project grows. Integrate DevView early for the best developer and QA experience.

Next Steps

Ready to get started? Head to the Installation Guide to begin!

Need Help?

If you encounter any issues: