feature/splash_screen

.github/workflows/codelab.yml

@@ -0,0 +1,59 @@
+name: Build and Deploy Codelab
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'codelab/codelab.md'
+
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    name: Build Codelab
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.21'
+
+      - name: Install claat
+        run: go install github.com/googlecodelabs/tools/claat@latest
+
+      - name: Build Codelab HTML
+        run: |
+          # Add go bin to the workflow's PATH
+          export PATH="$PATH:$(go env GOPATH)/bin"
+
+          # Run claat.
+          claat export codelab/codelab.md
+
+          # The output folder name is unchanged, it comes from the 'id'
+          mv my-tasks-github-actions-codelab dist
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: './dist'
+
+  deploy:
+    name: Deploy Codelab
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,6 +1,17 @@
 # My Tasks
 
-A modern Android task management app built with Kotlin, Jetpack Compose, and a clean architecture approach. It demonstrates best practices around state-driven UIs, Kotlin coroutines and flows, Room persistence, and dependency injection with Koin.
+A modern Android task management app built with Kotlin, Jetpack Compose, and a clean architecture
+approach. It demonstrates best practices around state-driven UIs, Kotlin coroutines and flows, Room
+persistence, and dependency injection with Koin.
+
+## Screenshots
+
+<p>
+  <img src="/codelab/images/1.webp" width="200" alt="Screenshot 1"/>
+  <img src="/codelab/images/2.webp" width="200" alt="Screenshot 2"/>
+  <img src="/codelab/images/3.webp" width="200" alt="Screenshot 3"/>
+  <img src="/codelab/images/4.webp" width="200" alt="Screenshot 4"/>
+</p>
 
 ## Features
 
@@ -16,23 +27,29 @@ A modern Android task management app built with Kotlin, Jetpack Compose, and a c
 ## Tech Stack
 
 **Language & Runtime**
+
 - Kotlin
 - Coroutines & Flows
 
 **Android & Jetpack**
+
 - Jetpack Compose UI
 - Navigation-Compose
 - ViewModel / Lifecycle
 - Room for local data storage
 
 **Architecture**
+
 - Clean-ish layered architecture:
-  - `core/domain`: use cases and domain models
-  - `core/data`: repositories and Room entities/DAOs
-  - `feature/*`: UI + ViewModels per feature (home, task details, new task, update task)
-- Unidirectional data flow: `Event -> ViewModel -> State/Effect -> UI`
+    - `core/domain`: use cases and domain models
+    - `core/data`: repositories and Room entities/DAOs
+    - `core/ui`: shared UI components, theme, and helper functions
+    - `feature/*`: UI + ViewModels per feature (home, task details, new task, update task)
+    - Unidirectional data flow using Model-View-Intent (MVI):
+      `Event -> ViewModel -> State/Effect -> UI`
 
 **Dependency Injection & Tools**
+
 - Koin (with KSP for DI code generation)
 - JUnit 5
 - MockK
@@ -70,18 +87,76 @@ My-Tasks/
 - Android Studio Giraffe or newer
 - Gradle wrapper (provided in the repo)
 
-> Note: Newer Java versions (e.g., 25) may not be fully supported by the Kotlin/Gradle toolchain used here. If you see errors like `java.lang.IllegalArgumentException: 25.0.1`, run Gradle with JDK 21.
+> Note: Newer Java versions (e.g., 25) may not be fully supported by the Kotlin/Gradle toolchain
+> used here. If you see errors like `java.lang.IllegalArgumentException: 25.0.1`, run Gradle with JDK
+21.
 
 ## Getting Started
 
-### 1. Clone the repository
+### 1. Fork the repository (Optional - for contributors)
+
+If you want to contribute or set up your own version with CI/CD:
+
+1. Click the **Fork** button at the top right of this repository
+2. Clone your forked repository:
+
+```bash
+git clone https://github.com/YOUR_USERNAME/My-Tasks.git
+cd My-Tasks
+```
+
+#### Setting up GitHub Secrets
+
+To enable the automated workflows (Pull Request checks and Google Play deployment), you need to
+configure the following secrets in your repository settings:
+
+1. Go to your forked repository on GitHub
+2. Navigate to **Settings** → **Secrets and variables** → **Actions**
+3. Click **New repository secret** and add each of the following:
+
+**Required Secrets for Release Workflow:**
+
+| Secret Name             | Description                        | How to Get It                                    |
+|-------------------------|------------------------------------|--------------------------------------------------|
+| `KEYSTORE_PASSWORD`     | Password for your Android keystore | The password you set when creating your keystore |
+| `KEY_ALIAS`             | Alias name for your signing key    | The alias you used when creating your key        |
+| `KEY_PASSWORD`          | Password for your signing key      | The password you set for your signing key        |
+| `ANDROID_KEYSTORE`      | Base64-encoded keystore file       | Run: `base64 -w 0 your-keystore.jks`             |
+| `GOOGLE_PLAY_AUTH_JSON` | Google Play service account JSON   | Download from Google Play Console → API access   |
+
+**Creating an Android Keystore (if you don't have one):**
+
+```bash
+keytool -genkey -v -keystore release-key.jks -keyalg RSA -keysize 2048 -validity 10000 -alias your-key-alias
+```
+
+**Encoding the Keystore for GitHub Secrets:**
+
+```bash
+base64 -w 0 release-key.jks > keystore-base64.txt
+# Copy the content of keystore-base64.txt and paste it as ANDROID_KEYSTORE secret
+```
+
+**Setting up Google Play Service Account:**
+
+1. Follow this tutorial
+   to [create a Google Play service account](https://medium.com/automating-react-native-app-release-to-google-play/create-google-play-service-account-68471d4b398b)
+2. Download the JSON key file
+3. Copy the entire JSON content and paste it as `GOOGLE_PLAY_AUTH_JSON` secret
+
+> **Note:** The release workflow will only trigger when you push a tag (e.g., `v1.0.0`). The pull
+> request workflow runs automatically on PRs to `main` or `develop` branches.
+
+### 2. Clone the repository (Simple setup)
+
+If you just want to build and run the app locally without CI/CD:
 
 ```bash
 git clone https://github.com/dev-ali-mansour/My-Tasks.git
 cd My-Tasks
 ```
 
-### 2. Configure Java
+### 3. Configure Java
 
 On Linux, if you have JDK 21 installed at `/usr/lib/jvm/java-21-openjdk`:
 
@@ -93,13 +168,13 @@ java -version
 
 You should see a Java 21 version.
 
-### 3. Open in Android Studio
+### 4. Open in Android Studio
 
 1. `File` → `Open...`
 2. Select the `My-Tasks` folder.
 3. Let Gradle sync and KSP/Room code generation complete.
 
-### 4. Build and run
+### 5. Build and run
 
 From Android Studio:
 
@@ -186,5 +261,6 @@ A clean rebuild can often resolve stale generated code:
 
 ## License
 
-This project is provided as-is for learning and demonstration purposes. Adapt licensing as needed for your use case.
+This project is provided as-is for learning and demonstration purposes. Adapt licensing as needed
+for your use case.
 

app/build.gradle.kts

@@ -200,6 +200,7 @@ dependencies {
     implementation(libs.androidx.compose.material3)
     implementation(libs.androidx.constraintlayout)
     implementation(libs.androidx.navigation)
+    implementation(libs.splashScreen)
     implementation(libs.androidx.lifecycle.runtimeCompose)
     implementation(libs.androidx.lifecycle.viewModelCompose)
     implementation(libs.multidex)

app/src/main/AndroidManifest.xml

@@ -14,8 +14,7 @@
         <activity
             android:name=".MainActivity"
             android:exported="true"
-            android:label="@string/app_name"
-            android:theme="@style/Theme.MyTasks"
+            android:theme="@style/Theme.MyTasks.MySplash"
             android:windowSoftInputMode="adjustResize">
             <intent-filter>
                 <action android:name="android.intent.action.MAIN" />

app/src/main/java/dev/alimansour/mytasks/MainActivity.kt

@@ -1,15 +1,38 @@
 package dev.alimansour.mytasks
 
+import android.graphics.Color
 import android.os.Bundle
 import androidx.activity.ComponentActivity
+import androidx.activity.SystemBarStyle
 import androidx.activity.compose.setContent
 import androidx.activity.enableEdgeToEdge
+import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
+import androidx.lifecycle.lifecycleScope
 import dev.alimansour.mytasks.core.ui.theme.MyTasksTheme
+import kotlinx.coroutines.delay
+import kotlinx.coroutines.launch
 
 class MainActivity : ComponentActivity() {
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
-        enableEdgeToEdge()
+        var isLoadingSplash = true
+        lifecycleScope.launch {
+            delay(timeMillis = 1500L)
+            isLoadingSplash = false
+        }
+
+        installSplashScreen().setKeepOnScreenCondition {
+            isLoadingSplash
+        }
+
+        enableEdgeToEdge(
+            navigationBarStyle =
+                SystemBarStyle.light(
+                    Color.TRANSPARENT,
+                    Color.TRANSPARENT,
+                ),
+        )
+
         setContent {
             MyTasksTheme {
                 MainApp()

app/src/main/res/values-night/themes.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+
+    <style name="Theme.MyTasks" parent="android:Theme.Material.Light.NoActionBar">
+        <item name="windowActionBar">false</item>
+        <item name="android:windowActionBar">false</item>
+        <item name="windowNoTitle">true</item>
+        <item name="android:windowNoTitle">true</item>
+    </style>
+
+    <style name="Theme.MyTasks.MySplash" parent="Theme.SplashScreen">
+        <item name="windowActionBar">false</item>
+        <item name="android:windowActionBar">false</item>
+        <item name="windowNoTitle">true</item>
+        <item name="android:windowNoTitle">true</item>
+        <item name="windowSplashScreenBackground">@color/splash_background_dark</item>
+        <item name="windowSplashScreenAnimatedIcon">@mipmap/ic_launcher_round</item>
+        <item name="postSplashScreenTheme">@style/Theme.MyTasks</item>
+    </style>
+</resources>

app/src/main/res/values/colors.xml

@@ -7,4 +7,8 @@
     <color name="teal_700">#FF018786</color>
     <color name="black">#FF000000</color>
     <color name="white">#FFFFFFFF</color>
+
+    <color name="splash_background_light">#FFFFFFFF</color>
+<!--    <color name="splash_background_light">#FFE8F5E9</color>-->
+    <color name="splash_background_dark">#FF0D1F0D</color>
 </resources>

app/src/main/res/values/themes.xml

@@ -1,5 +1,20 @@
 <?xml version="1.0" encoding="utf-8"?>
 <resources>
 
-    <style name="Theme.MyTasks" parent="android:Theme.Material.Light.NoActionBar" />
+    <style name="Theme.MyTasks" parent="android:Theme.Material.Light.NoActionBar">
+        <item name="windowActionBar">false</item>
+        <item name="android:windowActionBar">false</item>
+        <item name="windowNoTitle">true</item>
+        <item name="android:windowNoTitle">true</item>
+    </style>
+
+    <style name="Theme.MyTasks.MySplash" parent="Theme.SplashScreen">
+        <item name="windowActionBar">false</item>
+        <item name="android:windowActionBar">false</item>
+        <item name="windowNoTitle">true</item>
+        <item name="android:windowNoTitle">true</item>
+        <item name="windowSplashScreenBackground">@color/splash_background_light</item>
+        <item name="windowSplashScreenAnimatedIcon">@mipmap/ic_launcher_round</item>
+        <item name="postSplashScreenTheme">@style/Theme.MyTasks</item>
+    </style>
 </resources>