From 36eb2b9ed3464d8191366223d5e154765853bcd3 Mon Sep 17 00:00:00 2001
From: Timothy Jaeryang Baek <tim@openwebui.com>
Date: Thu, 18 Sep 2025 23:23:09 -0500
Subject: [PATCH] rename

---
 servers/flashcard/README.md                   | 14 ------
 .../{flashcard => flashcards}/.dockerignore   |  0
 .../.webui_secret_key                         |  0
 servers/{flashcard => flashcards}/Dockerfile  |  0
 servers/flashcards/README.md                  | 47 +++++++++++++++++++
 .../{flashcard => flashcards}/compose.yaml    |  0
 servers/{flashcard => flashcards}/main.py     |  0
 .../requirements.txt                          |  0
 8 files changed, 47 insertions(+), 14 deletions(-)
 delete mode 100644 servers/flashcard/README.md
 rename servers/{flashcard => flashcards}/.dockerignore (100%)
 rename servers/{flashcard => flashcards}/.webui_secret_key (100%)
 rename servers/{flashcard => flashcards}/Dockerfile (100%)
 create mode 100644 servers/flashcards/README.md
 rename servers/{flashcard => flashcards}/compose.yaml (100%)
 rename servers/{flashcard => flashcards}/main.py (100%)
 rename servers/{flashcard => flashcards}/requirements.txt (100%)

diff --git a/servers/flashcard/README.md b/servers/flashcard/README.md
deleted file mode 100644
index a792c9d..0000000
--- a/servers/flashcard/README.md
+++ /dev/null
@@ -1,14 +0,0 @@
-# Simple Flashcard Display API
-
-A simple tool for AI to display interactive flashcards.
-
-## 🚀 Quickstart
-
-```bash
-git clone https://github.com/open-webui/openapi-servers
-cd openapi-servers/servers/time
-pip install -r requirements.txt
-uvicorn main:app --host 0.0.0.0 --reload
-```
-
-You're live. ⏱️📡
\ No newline at end of file
diff --git a/servers/flashcard/.dockerignore b/servers/flashcards/.dockerignore
similarity index 100%
rename from servers/flashcard/.dockerignore
rename to servers/flashcards/.dockerignore
diff --git a/servers/flashcard/.webui_secret_key b/servers/flashcards/.webui_secret_key
similarity index 100%
rename from servers/flashcard/.webui_secret_key
rename to servers/flashcards/.webui_secret_key
diff --git a/servers/flashcard/Dockerfile b/servers/flashcards/Dockerfile
similarity index 100%
rename from servers/flashcard/Dockerfile
rename to servers/flashcards/Dockerfile
diff --git a/servers/flashcards/README.md b/servers/flashcards/README.md
new file mode 100644
index 0000000..30a29cb
--- /dev/null
+++ b/servers/flashcards/README.md
@@ -0,0 +1,47 @@
+# 🃏 Simple Flashcard Display API
+A lightweight FastAPI service to display interactive flashcards in the browser.
+
+## 🚀 Quickstart
+
+```bash
+# Clone the repo
+git clone https://github.com/open-webui/openapi-severs
+cd openapi-servers/servers/flashcards
+
+# Install dependencies
+pip install -r requirements.txt
+
+# Run the server
+uvicorn main:app --host 0.0.0.0 --reload
+```
+
+Your API is now live at:
+👉 `http://localhost:8000`
+
+## 📚 Usage
+
+Send a POST request to `/display` with JSON payload:
+
+```json
+{
+  "title": "My Flashcards",
+  "description": "Practice questions",
+  "cards": [
+    { "front": "What is 2 + 2?", "back": "4" },
+    { "front": "Capital of France?", "back": "Paris" }
+  ]
+}
+```
+
+The server will return a clean, interactive HTML page where you can:
+- Flip cards to reveal answers
+- Navigate with Previous/Next buttons
+- View progress with a counter
+
+## 🌐 Endpoints
+- `GET /` → Home page with instructions  
+- `POST /display` → Display your flashcards  
+
+---
+
+Perfect for AI-generated learning tools, quizzes, or study helpers. 🎓✨
\ No newline at end of file
diff --git a/servers/flashcard/compose.yaml b/servers/flashcards/compose.yaml
similarity index 100%
rename from servers/flashcard/compose.yaml
rename to servers/flashcards/compose.yaml
diff --git a/servers/flashcard/main.py b/servers/flashcards/main.py
similarity index 100%
rename from servers/flashcard/main.py
rename to servers/flashcards/main.py
diff --git a/servers/flashcard/requirements.txt b/servers/flashcards/requirements.txt
similarity index 100%
rename from servers/flashcard/requirements.txt
rename to servers/flashcards/requirements.txt