From d6707295cc4b795033b73e51e780b688ed037acd Mon Sep 17 00:00:00 2001
From: BennyKok <itechbenny@gmail.com>
Date: Fri, 5 Jan 2024 19:26:51 +0800
Subject: [PATCH] chore: add readme for modal builder

---
 builder/modal-builder/.env.example |  3 +++
 builder/modal-builder/README.md    | 22 ++++++++++++++++++++++
 2 files changed, 25 insertions(+)
 create mode 100644 builder/modal-builder/.env.example
 create mode 100644 builder/modal-builder/README.md

diff --git a/builder/modal-builder/.env.example b/builder/modal-builder/.env.example
new file mode 100644
index 0000000..69285d7
--- /dev/null
+++ b/builder/modal-builder/.env.example
@@ -0,0 +1,3 @@
+MODAL_TOKEN_ID=
+MODAL_TOKEN_SECRET=
+DEPLOY_TEST_FLAG=True
\ No newline at end of file
diff --git a/builder/modal-builder/README.md b/builder/modal-builder/README.md
new file mode 100644
index 0000000..4dea6b1
--- /dev/null
+++ b/builder/modal-builder/README.md
@@ -0,0 +1,22 @@
+# Modal Builder
+
+This is a standalone docker fast api app that will takes in require snapshot of the machine and build it as a new modal apps and returns back the deployment url.
+
+Environment variable, get it from you [modal accounts](https://modal.com/bennykok/settings/tokens)
+
+```shellscript
+MODAL_TOKEN_ID=
+MODAL_TOKEN_SECRET=
+```
+
+To run locally
+
+```
+docker build -t bennykok/comfydeploy-builder:dev . && docker run --env-file .env -p 8080:8080 bennykok/comfydeploy-builder:dev
+```
+
+To deploy
+
+```
+fly deploy
+```
\ No newline at end of file