README.md

Jetpack Compose Starter 🚀

A robust, production-ready template for modern Android development that takes the pain out of setting up a new project. Built on the foundation of Now In Android's architecture, this template provides a comprehensive starting point for both new and experienced Android developers.

Apps Built With This Template

Check out apps built with this template here.

Why This Template?

• Production-Ready Authentication: Firebase authentication with Google Sign-In and email/password
• Clean Architecture: Clear separation of concerns with a modular, scalable architecture
• Modern Tech Stack: Latest Android development tools including Jetpack Compose
• Type-Safe Navigation: Fully typed navigation using Kotlin serialization
• Robust Data Management: Repository pattern with Room and DataStore
• Firebase Integration: Auth, Firestore, Analytics, and Crashlytics
• Background Sync: Data synchronization using WorkManager
• CI/CD: Automated build, release, and deployment with GitHub Actions

Technical Stack

Core Libraries

• UI: Jetpack Compose, Material3
• DI: Dagger Hilt
• Async: Kotlin Coroutines & Flow
• Network: Retrofit, OkHttp
• Storage: Room DB, DataStore
• Firebase: Auth, Firestore, Analytics
• Others: WorkManager, Coil

Build & Tools

• Kotlin 2.0
• Gradle 8.11.1 with Version Catalogs
• Java 21
• Custom Gradle Convention Plugins
• Dokka and MkDocs for documentation
• Spotless for code formatting

Documentation

📚 Full Documentation

Getting Started

• Quick Start Guide
• Firebase Setup
• Dependency Management

Architecture & Design

• Architecture Overview
• Design Philosophy
• Adding New Features

Development Tools

• Convention Plugins
• Code Style with Spotless
• Performance Optimization
• Useful Tips & Tricks

Deployment

• GitHub CI/CD Setup
• Fastlane Configuration

📚 API Reference

Qatar University Machine Learning Group