From 45cb62800fa2208a2abf461e127d711869ac45eb Mon Sep 17 00:00:00 2001
From: Rajtilak Bhattacharjee <rajtilak.blog@gmail.com>
Date: Fri, 29 Mar 2024 20:51:41 +0530
Subject: [PATCH] docs(swimm): create docs: Welcome to KeepYourMouthShut,
 Installation

---
 .swm/installation.d5h2djze.sw.md              | 18 +++++++++++++++
 .swm/swimm.json                               |  3 +++
 ...ome-to-keepyourmouthshut.bsh0v9im.pl.sw.md | 23 +++++++++++++++++++
 3 files changed, 44 insertions(+)
 create mode 100644 .swm/installation.d5h2djze.sw.md
 create mode 100644 .swm/swimm.json
 create mode 100644 .swm/welcome-to-keepyourmouthshut.bsh0v9im.pl.sw.md

diff --git a/.swm/installation.d5h2djze.sw.md b/.swm/installation.d5h2djze.sw.md
new file mode 100644
index 0000000..77f4edf
--- /dev/null
+++ b/.swm/installation.d5h2djze.sw.md
@@ -0,0 +1,18 @@
+---
+title: Installation
+---
+For local installation, clone the repository and run the following commands:
+
+1. Install [FFMPEG](https://ffmpeg.org/)
+
+2. Create a free account on [llmOS](https://www.llmos.dev/) and get an API key
+
+3. Insert the API key in the `.env` file. A sample `.env` file is given
+
+4. Run `pip install -r app/requirements.txt`
+
+5. Run `flask --app app/keepyourmouthshut.py run`
+
+This will start the Flask app on port 5000 within a development environment. You can view the app in your browser at `http://127.0.0.1:5000`
+
+<SwmMeta version="3.0.0" repo-id="Z2l0aHViJTNBJTNBa2VlcHlvdXJtb3V0aHNodXQlM0ElM0FyYWp0aWxha2plZQ==" repo-name="keepyourmouthshut"><sup>Powered by [Swimm](https://app.swimm.io/)</sup></SwmMeta>
diff --git a/.swm/swimm.json b/.swm/swimm.json
new file mode 100644
index 0000000..39aa003
--- /dev/null
+++ b/.swm/swimm.json
@@ -0,0 +1,3 @@
+{
+    "repo_id": "Z2l0aHViJTNBJTNBa2VlcHlvdXJtb3V0aHNodXQlM0ElM0FyYWp0aWxha2plZQ=="
+}
diff --git a/.swm/welcome-to-keepyourmouthshut.bsh0v9im.pl.sw.md b/.swm/welcome-to-keepyourmouthshut.bsh0v9im.pl.sw.md
new file mode 100644
index 0000000..920bd7b
--- /dev/null
+++ b/.swm/welcome-to-keepyourmouthshut.bsh0v9im.pl.sw.md
@@ -0,0 +1,23 @@
+---
+id: bsh0v9im
+title: Welcome to KeepYourMouthShut
+file_version: 1.1.3
+app_version: 1.24.3
+---
+
+<!-- Intro - Do not remove this comment -->
+KeepYourMouthShut is an AI-assisted open-source app that provides a 360-degree podcast solution.
+
+It has a developer-first approach for creating entire episodes of podcasts without requiring any expensive equpment or setup. The app takes a number of input from the end-user and based on that generates a script and an audio voice-over file based on that script.
+
+<br/>
+
+<br/>
+
+<!-- Steps - Do not remove this comment -->
+1. [Installation](installation.d5h2djze.sw.md)
+
+
+<br/>
+
+This file was generated by Swimm. [Click here to view it in the app](https://app.swimm.io/repos/Z2l0aHViJTNBJTNBa2VlcHlvdXJtb3V0aHNodXQlM0ElM0FyYWp0aWxha2plZQ==/playlists/bsh0v9im).