|
1 |
| -<h1 align="center"> 🚀 Product Sample Supabase</h1> |
| 1 | +# 🚀 Product Sample Supabase |
2 | 2 |
|
3 | 3 | [](https://supabase.com)
|
4 | 4 |
|
5 |
| -<!-- <img width="964" alt="Screen Shot 2023-06-02 at 21 33 16" src="https://github.com/hieuwu/product-sample-supabase-kt/assets/43868345/288eef97-d8fe-422f-8bb3-1c8424bab08e"> |
| 5 | + |
6 | 6 |
|
7 |
| -<img width="1092" alt="Screen Shot 2023-06-05 at 21 39 24" src="https://github.com/hieuwu/product-sample-supabase-kt/assets/43868345/3f154fda-aa9e-4baa-81f2-5b744c7ad2fe"> --> |
| 7 | +## 📖 Overview |
8 | 8 |
|
9 |
| - |
10 |
| -[](https://github.com/hieuwu/product-sample-supabase-kt/actions/workflows/app-build.yml) |
| 9 | +This project is a modern Android application built with **Jetpack Compose**, showcasing **best practices** for integrating **Supabase** for **authentication**, **OAuth**, **storage**, and **real-time CRUD operations**. It serves as a reference for developers aiming to build scalable, maintainable Android apps with a robust backend. |
11 | 10 |
|
12 |
| -### About |
13 |
| -Demonstration and best practices of how to use Supabase database for CRUD operation |
| 11 | +### 🎯 Features |
| 12 | +- **Supabase Integration**: Email/password authentication, OAuth (e.g., Google), file storage, and real-time database operations. |
| 13 | +- **Jetpack Compose**: Declarative UI for a responsive and modern user experience. |
| 14 | +- **Hilt Dependency Injection**: Clean architecture for modularity and testability. |
| 15 | +- **Real-time Data**: Leverages Supabase's real-time subscriptions for live updates. |
| 16 | +- **CI/CD**: Automated builds and testing via GitHub Actions. |
| 17 | +- **Image Loading**: Efficient image handling with Coil. |
14 | 18 |
|
15 |
| -### Setup |
16 |
| -Android Studio with SDK 30 or above |
17 |
| -Open `local.properties` file, add these |
18 |
| -```kotlin |
19 |
| -API_KEY=YOUR_SUPABASE_API_KEY |
20 |
| -SECRET=YOUR_SUPABASE_SECRET |
21 |
| -SUPABASE_URL=YOUR_SUPABASE_URL |
| 19 | +## 🛠️ Setup |
22 | 20 |
|
23 |
| -``` |
| 21 | +### Prerequisites |
| 22 | +- **Android Studio**: SDK 30 (Android 11) or higher. |
| 23 | +- **Supabase Account**: Obtain API key, secret, and project URL from [Supabase](https://supabase.com). |
| 24 | +- **Kotlin**: Version 1.9.0 or higher recommended. |
| 25 | + |
| 26 | +### Installation |
| 27 | +1. Clone the repository: |
| 28 | + ```bash |
| 29 | + git clone https://github.com/hieuwu/product-sample-supabase-kt.git |
| 30 | + ``` |
| 31 | +2. Open the project in Android Studio. |
| 32 | +3. Create or update the `local.properties` file in the project root: |
| 33 | + ```kotlin |
| 34 | + API_KEY=YOUR_SUPABASE_API_KEY |
| 35 | + SECRET=YOUR_SUPABASE_SECRET |
| 36 | + SUPABASE_URL=YOUR_SUPABASE_URL |
| 37 | + ``` |
| 38 | + Replace `YOUR_SUPABASE_API_KEY`, `YOUR_SUPABASE_SECRET`, and `YOUR_SUPABASE_URL` with values from your Supabase project dashboard. |
| 39 | +4. Sync the project with Gradle and build the app. |
0 commit comments