-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(swimm): create docs: Welcome to KeepYourMouthShut, Installation
- Loading branch information
1 parent
162a59a
commit 45cb628
Showing
3 changed files
with
44 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"repo_id": "Z2l0aHViJTNBJTNBa2VlcHlvdXJtb3V0aHNodXQlM0ElM0FyYWp0aWxha2plZQ==" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |