Basket Scan and Go is a cross-platform shopping application that allows customers to scan products, add them to a virtual basket, and check out without waiting in line. The application is built using Kotlin Multiplatform and Compose Multiplatform, enabling a shared codebase across Android, iOS, Desktop, and Web platforms.
- Product Scanning: Scan product barcodes to add items to your basket
- Basket Management: Create, view, and modify shopping baskets
- User Authentication: Secure login and user management
- Shared Baskets: Option to share baskets with other users
- Cross-Platform: Works on Android, iOS, Desktop, and Web
- 🧩 Compose Multiplatform; for shared UI
- 🌐 Ktor; for networking
- 📦 Kotlinx Serialization; for content negotiation
- 🕰️ Kotlinx Datetime; for datetime
- 🧹 ktlint; for Kotlin linting and formatting
- 🔄 Kotlin Coroutines; for asynchronous programming
- 💉 Koin; for dependency injection
Open Run Config action:
or you can run it from file .fleet/run.json
TBD
| platform | gradle command |
|---|---|
| android | TBD |
| ios | /Applications/Xcode.app/Contents/Developer/usr/bin/xcodebuild -project app/ios/ios.xcodeproj -scheme ComposeApp -configuration Debug |
| desktop | ./gradlew :composeApp:desktopRun -DmainClass=com.basket.sample.scango.DesktopAppKt |
| js | ./gradlew :composeApp:jsBrowserDevelopmentRun |
| wasm | ./gradlew :composeApp:wasmJsBrowserDevelopmentRun |
This project uses ktlint for Kotlin code style checking and formatting. ktlint is a linter with built-in formatter that enforces the official Kotlin code style.
./gradlew ktlintCheck- Run ktlint check on all modules./gradlew ktlintFormat- Run ktlint format on all modules to automatically fix style violations./gradlew <module>:ktlintCheck- Run ktlint check on a specific module./gradlew <module>:ktlintFormat- Run ktlint format on a specific module
For IntelliJ IDEA / Android Studio, you can install the ktlint plugin to get real-time linting and formatting.
The application follows Clean Architecture principles with a clear separation of concerns:
┌─────────────────────────────────────────────────────────────────┐
│ PRESENTATION LAYER │
│ │
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
│ │ ViewModels │ │ Screen States │ │ Events │ │
│ └────────┬────────┘ └─────────────────┘ └─────────────────┘ │
│ │ │
└───────────┼─────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────────┐
│ DOMAIN LAYER │
│ │
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
│ │ Use Cases │ │ Domain Models │ │ Repositories │ │
│ │ Interface │ │ │ │ Interface │ │
│ └────────┬────────┘ └─────────────────┘ └────────┬────────┘ │
│ │ │ │
└───────────┼─────────────────────────────────────────┼───────────┘
│ │
▼ ▼
┌─────────────────────────────────────────────────────────────────┐
│ DATA LAYER │
│ │
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
│ │ Repository Impl │ │ Data Sources │ │ DTOs/APIs │ │
│ └────────┬────────┘ └────────┬────────┘ └────────┬────────┘ │
│ │ │ │ │
└───────────┼────────────────────┼────────────────────┼───────────┘
│ │ │
▼ ▼ ▼
┌─────────────────────────────────────────────────────────────────┐
│ PLATFORM LAYER │
│ │
│ ┌─────────────────┐ ┌─────────────────┐ ┌─────────────────┐ │
│ │ Result │ │ KLogger │ │ KTime │ │
│ └─────────────────┘ └─────────────────┘ └─────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────────┘
composeApp (UI Implementation)
│
├── core/designSystem (UI Components)
│
├── core/di (Dependency Injection)
│ ├── core/logic/presentation
│ ├── core/logic/data
│ └── platform/ktime
│
└── core/logic/presentation (ViewModels, States)
│
├── core/logic/domain (Use Cases, Models)
│ │
│ ├── platform/result
│ │ │
│ │ └── platform/ktime
│ │
│ └── platform/klogger
│ │
│ └── platform/ktime
│
├── core/logic/data (Repositories, Data Sources)
│ │
│ ├── core/logic/domain
│ └── platform/klogger
│
├── core/designSystem
│
└── platform/klogger
The following diagram shows a more detailed view of module dependencies in the project:
+---------------------+ +---------------------+ +---------------------+
| APPLICATION | | CORE | | LOGIC |
| MODULES | | MODULES | | MODULES |
+---------------------+ +---------------------+ +---------------------+
| :composeApp | | :designSystem | | :presentation |
| (UI Implementation) | | (UI Components) | | (ViewModels, States)|
| | | | | |
| :iosApp | | :di | | :domain |
| (iOS-specific code) | | (Dependency | | (Use Cases, Models) |
| | | Injection) | | |
| :basket-server | | | | :data |
| (Ktor-based backend | | | | (Repositories, |
| server) | | | | |
| | | | | Data Sources) |
+---------------------+ +---------------------+ +---------------------+
| | | | | | |
| | | | | | |
| | | | | | |
| +---------------------->+ | | | |
| | | | | |
| +---------------------->+ | | | |
| | | | | | |
| | | +--------------------->+ | |
| | | | | |
| | +------------------------->+ | |
| | | | |
+--+------------------------------------------------->+ | |
| | | |
| | | |
| v v v
| +---------------------+
| | PLATFORM |
| | MODULES |
| +---------------------+
| | :klogger |
| | (Logging utilities) |
| | |
| | :ktime |
+----------------------------------------->| (Date and time |
| utilities) |
| |
| :result |
| (Result monad for |
| error handling) |
+---------------------+
Dependencies:
- composeApp -> presentation, di
- di -> presentation, data, ktime
- presentation -> domain, data, designSystem, klogger
- domain -> result, klogger
- data -> domain, klogger
- klogger -> ktime
- result -> ktime
This diagram illustrates:
- Application Modules: The main entry points for different platforms
- Core Modules: Shared UI components and dependency injection
- Logic Modules: Business logic implementation following Clean Architecture
- Platform Modules: Utility modules used across the application
The arrows indicate dependencies between modules, showing how they rely on each other.
-
Core Modules:
- designSystem: UI components and styling
- di: Dependency injection setup
- logic: Business logic implementation
- data: Repositories and data sources
- domain: Use cases and domain models
- presentation: ViewModels and UI state management
-
Platform Modules:
- klogger: Logging utilities
- ktime: Date and time utilities
- result: Result monad for error handling
-
Platform-Specific Modules:
- composeApp: Shared UI implementation
- iosApp: iOS-specific code
- server: Ktor-based backend server implementation (documentation)
┌────────────────────────────────────────────────────────────┐
│ │
│ Commit Frequency │
│ │
│ 15 ┼ ╭─╮ │
│ │ │ │ │
│ 12 ┼ │ │ │
│ │ │ │ │
│ 9 ┼ ╭────╮ │ │ │
│ │ │ │ │ │ │
│ 6 ┼ ╭─╮ │ │ │ │ ╭─╮ │
│ │ │ │ │ │ │ │ │ │ │
│ 3 ┼ ╭─╮ │ │ ╭─╮ │ │ │ │ │ │ ╭─╮ │
│ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │ │
│ 0 ┼────────┴─┴───┴─┴───┴─┴─┴────┴───┴─┴────┴─┴────┴─┴───│
│ Jan Feb Mar Apr May Jun Jul Aug Sep │
│ │
└────────────────────────────────────────────────────────────┘
The Basket Scan and Go application provides significant benefits to users:
- Time Savings: Users can scan products as they shop and skip checkout lines
- Convenience: Easy basket management and sharing capabilities
- Cross-Platform Access: Use the same application across different devices
- Real-time Updates: Immediate product and price information
┌──────────────────────────────────────────────────────────┐
│ │
│ Feature Development Distribution │
│ │
│ UI/UX Improvements ███████████████████████ 35% │
│ Basket Management ██████████████████ 27% │
│ Authentication ███████████ 16% │
│ Cross-Platform ████████ 12% │
│ Performance ██████ 10% │
│ │
└──────────────────────────────────────────────────────────┘
Below are screenshots of the Basket Scan and Go application running on different platforms.
