TwoNote

TwoNote is a Kotlin Multiplatform note-taking application built with a microkernel architecture, targeting Android, Web, Desktop (JVM), and Server platforms.

Documentation

For a comprehensive installation guide, please refer to the Manual Installation Documentation.

Architecture

The project follows a microkernel (plugin-based) architecture where almost all functionality is implemented as plugins. This design provides:

• Extensibility: New features can be added as plugins without modifying the core
• Modularity: Each plugin is self-contained and can be developed independently
• Flexibility: Plugins can be enabled/disabled and configured at runtime
• Maintainability: Clear separation between core kernel and feature implementations

Project Structure

• /shared - The microkernel core

  • Contains the plugin API and kernel implementation in commonMain
  • Key components:
    • TwoNoteKernel: The core kernel interface
    • PluginManager: Handles plugin lifecycle and registration
    • Plugin & AutoPlugin: Base interfaces for plugin development
    • PluginManifest: Plugin metadata and capabilities

• /plugins - Plugin modules (all features are plugins!)

  • ui: User interface components and screens
  • settings: Application settings and configuration
  • info: Information and about screens
  • io: Input/output operations and file handling

• /plugins-processor - KSP-based plugin processor

  • Handles compile-time plugin discovery and code generation

• /composeApp - Compose Multiplatform application

  • Platform-specific implementations:
    • commonMain: Shared UI code
    • androidMain: Android-specific code
    • jvmMain: Desktop (JVM) specific code
    • wasmJsMain/jsMain: Web-specific code

• /server - Ktor server application

Creating a Plugin

To create a new plugin:

1. Create a new module under /plugins
2. Implement the Plugin or AutoPlugin interface
3. Define your plugin's PluginManifest with metadata and capabilities
4. The plugin will be automatically discovered by the plugin processor

Building and Running

Android Application

Build and run the Android app using the run configuration from your IDE's toolbar or from terminal:

# macOS/Linux
./gradlew :composeApp:assembleDebug

# Windows
.\gradlew.bat :composeApp:assembleDebug

Desktop (JVM) Application

Run the desktop application:

# macOS/Linux
./gradlew :composeApp:run

# Windows
.\gradlew.bat :composeApp:run

Server

Run the Ktor server:

# macOS/Linux
./gradlew :server:run

# Windows
.\gradlew.bat :server:run

Web Application

Run the web application:

Wasm target (faster, modern browsers):

# macOS/Linux
./gradlew :composeApp:wasmJsBrowserDevelopmentRun

# Windows
.\gradlew.bat :composeApp:wasmJsBrowserDevelopmentRun

JS target (supports older browsers):

# macOS/Linux
./gradlew :composeApp:jsBrowserDevelopmentRun

# Windows
.\gradlew.bat :composeApp:jsBrowserDevelopmentRun

Technologies

• Kotlin Multiplatform: Cross-platform development
• Compose Multiplatform: Declarative UI framework
• Kotlin/Wasm: WebAssembly support for web targets
• Ktor: Server-side framework
• KSP (Kotlin Symbol Processing): Compile-time plugin processing