Binary

The pre-built APK file can be downloaded from here to experience the app on your Android phone without any hassle (uses a pre-deployed Modal.com backend).
To build the app from source, read the rest of this document.

Prerequisites

Flutter SDK >=3.7
Python 3.8
Gradle 8.9.1
Java/JDK 17 & Kotlin
Android SDK & NDK
Platform Level >=34
Build Tools >=34.0.0
NDK Version 27.0.12077973
CMake 3.22.1

Ensure that all these programs with the correct versions are installed on your system before using this repository

Note

For Nix users, a Flake for the development shell is provided

Setup

1. Download Models

Download all the models from here and place them inside the assets directory

2. Setup Python

The Android app compiles Python code using Chaquopy, which requires the following setup, mandatorily using Python Version 3.8:

A) Install Python 3.8

Download from python.org

B) Set up Virtual Environment

python -m venv python_env

3. Create .env

Create the .env file in the root directory containing the following:

URL_ASSET=<Background Removal Backend Endpoint>
URL_DESCRIBE=<Florence-v2 Description Backend Endpoint>
URL_GENERATE=<Stable Diffusion Image Generation Backend Endpoint>
URL_INPAINTING=<Stable Diffusion Inpainting Backend Endpoint>
URL_INPAINTING_API=<Fal.ai Inpainting Backend Endpoint>
URL_SKETCH_API=<Sketch to Image Backend Endpoint>
SHARED_SECRET_KEY=<Base64 Security Key>

4. Build the application APK

flutter clean
flutter pub get
flutter build apk

If you have adb properly installed, you can use flutter run

Backend

Read flask/README.md to run the server

1# Binary 2 3The pre-built APK file can be downloaded from [here](https://github.com/maydayv7/creek/releases/latest/download/app-release.apk) to experience the app on your Android phone without any hassle (uses a pre-deployed [Modal.com](https://modal.com) backend). 4To build the app from source, read the rest of this document. 5 6# Prerequisites 7 8- Flutter SDK **>=3.7** 9- Python **3.8** 10- Gradle **8.9.1** 11- Java/JDK **17** & Kotlin 12- Android SDK & NDK 13 - Platform Level **>=34** 14 - Build Tools **>=34.0.0** 15 - NDK Version **27.0.12077973** 16 - CMake **3.22.1** 17 18Ensure that all these programs with the correct versions are installed on your system before using this repository 19 20> [!NOTE] 21> For [Nix](https://nixos.org/) users, a [Flake](./flake.nix) for the development shell is provided 22 23# Setup 24 25### 1. Download Models 26 27Download all the models from [here](https://drive.google.com/drive/folders/1b2cEsZao5miX7WxYmp160XkKd_lfBmPN) and place them inside the [`assets`](./assets) directory 28 29### 2. Setup Python 30 31The Android app compiles Python code using [Chaquopy](https://chaquo.com/chaquopy/), which requires the following setup, mandatorily using Python Version 3.8: 32 33#### A) Install Python 3.8 34 35Download from [python.org](https://www.python.org/downloads/release/python-3810/) 36 37#### B) Set up Virtual Environment 38 39```bash 40python -m venv python_env 41``` 42 43### 3. Create .env 44 45Create the `.env` file in the root directory containing the following: 46 47```dotenv 48URL_ASSET=<Background Removal Backend Endpoint> 49URL_DESCRIBE=<Florence-v2 Description Backend Endpoint> 50URL_GENERATE=<Stable Diffusion Image Generation Backend Endpoint> 51URL_INPAINTING=<Stable Diffusion Inpainting Backend Endpoint> 52URL_INPAINTING_API=<Fal.ai Inpainting Backend Endpoint> 53URL_SKETCH_API=<Sketch to Image Backend Endpoint> 54SHARED_SECRET_KEY=<Base64 Security Key> 55``` 56 57### 4. Build the application APK 58 59```bash 60flutter clean 61flutter pub get 62flutter build apk 63``` 64 65If you have `adb` properly installed, you can use `flutter run` 66 67# Backend 68 69Read [flask/README.md](flask/README.md) to run the server

creek

Rendered