creek

The AI Image Editor of 2030
git clone https://github.com/maydayv7/creek

INSTALL.md (2075B)

Rendered

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


Code

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# Binary

The 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).  
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](https://nixos.org/) users, a [Flake](./flake.nix) for the development shell is provided

# Setup

### 1. Download Models

Download all the models from [here](https://drive.google.com/drive/folders/1b2cEsZao5miX7WxYmp160XkKd_lfBmPN) and place them inside the [`assets`](./assets) directory

### 2. Setup Python

The Android app compiles Python code using [Chaquopy](https://chaquo.com/chaquopy/), which requires the following setup, mandatorily using Python Version 3.8:

#### A) Install Python 3.8

Download from [python.org](https://www.python.org/downloads/release/python-3810/)

#### B) Set up Virtual Environment

```bash
python -m venv python_env
```

### 3. Create .env

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

```dotenv
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

```bash
flutter clean
flutter pub get
flutter build apk
```

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

# Backend

Read [flask/README.md](flask/README.md) to run the server