From 952f7dbee9e702f12dfa0a25f26159a9c8421cee Mon Sep 17 00:00:00 2001
From: noptuno <repollo.marrero@gmail.com>
Date: Thu, 27 Apr 2023 19:15:50 -0400
Subject: First implementation of streamlit chat app in gui folder

---
 gui/README.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 64 insertions(+), 3 deletions(-)

(limited to 'gui/README.md')

diff --git a/gui/README.md b/gui/README.md
index 133abe4b..c638c4dc 100644
--- a/gui/README.md
+++ b/gui/README.md
@@ -1,11 +1,72 @@
 # gpt4free gui
 
-mode `streamlit_app.py` into base folder to run
+This code provides a Graphical User Interface (GUI) for gpt4free. Users can ask questions and get answers from GPT-4 API's, utilizing multiple API implementations. The project contains two different Streamlit applications: `streamlit_app.py` and `streamlit_chat_app.py`.
 
+Installation
+------------
+
+1.  Clone the repository.
+2.  Install the required dependencies with: `pip install -r requirements.txt`.
+3.  To use `streamlit_chat_app.py`, note that it depends on a pull request (PR #24) from the https://github.com/AI-Yash/st-chat/ repository, which may change in the future. The current dependency library can be found at https://github.com/AI-Yash/st-chat/archive/refs/pull/24/head.zip.
+
+Usage
+-----
+
+Choose one of the Streamlit applications to run:
+
+### streamlit\_app.py
+
+This application provides a simple interface for asking GPT-4 questions and receiving answers.
+
+To run the application:
+
+run:
+```arduino
+streamlit run gui/streamlit_app.py
+```
+<br>
+
+<img width="724" alt="image" src="https://user-images.githubusercontent.com/98614666/234232449-0d5cd092-a29d-4759-8197-e00ba712cb1a.png">   
+
+<br>
+<br>
 
 preview:  
+
 <img width="1125" alt="image" src="https://user-images.githubusercontent.com/98614666/234232398-09e9d3c5-08e6-4b8a-b4f2-0666e9790c7d.png">    
 
 
-run:    
-<img width="724" alt="image" src="https://user-images.githubusercontent.com/98614666/234232449-0d5cd092-a29d-4759-8197-e00ba712cb1a.png">   
+### streamlit\_chat\_app.py
+
+This application provides a chat-like interface for asking GPT-4 questions and receiving answers. It supports multiple query methods, and users can select the desired API for their queries. The application also maintains a conversation history.
+
+To run the application:
+
+```arduino
+streamlit run streamlit_chat_app.py
+```
+
+<br>
+
+<img width="724" alt="image" src="image1.png">   
+
+<br>
+<br>
+
+preview:  
+
+<img width="1125" alt="image" src="image2.png">    
+
+Contributing
+------------
+
+Feel free to submit pull requests, report bugs, or request new features by opening issues on the GitHub repository.
+
+Bug
+----
+There is a bug in `streamlit_chat_app.py` right now that I haven't pinpointed yet, probably is really simple but havent had the time to look for it. Whenever you open a new conversation or access an old conversation it will only start prompt-answering after the second time you input to the text input, other than that, everything else seems to work accordingly.
+
+License
+-------
+
+This project is licensed under the MIT License.
\ No newline at end of file
-- 
cgit v1.2.3