From 453301db0e57fbba8bf4d62c44fca568bc437ba9 Mon Sep 17 00:00:00 2001 From: Danny Avila Date: Mon, 6 Mar 2023 14:30:58 -0500 Subject: [PATCH] chore: edit readme and docker-compose --- .gitignore | 1 - README.md | 9 +++++++-- docker-compose.yml copy.example => docker-compose.yml | 2 +- 3 files changed, 8 insertions(+), 4 deletions(-) rename docker-compose.yml copy.example => docker-compose.yml (96%) diff --git a/.gitignore b/.gitignore index d76b6e9eb1..b45375a167 100644 --- a/.gitignore +++ b/.gitignore @@ -48,6 +48,5 @@ bower_components/ cache.json api/data/ .eslintrc.js -docker-compose.yml src/style - official.css \ No newline at end of file diff --git a/README.md b/README.md index 20853f6392..0c5dd26da2 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,14 @@ # ChatGPT Clone # ![chatgpt-clone demo](./public/demo.gif) ## Wrap all conversational AIs under one roof. ## - Assistant AIs are the future and OpenAI revolutionized this movement with ChatGPT. While numerous methods exist to integrate these AIs, this app commemorates the original styling of ChatGPT, with the ability to integrate any current/future AI models through user-provided API keys, while improving upon original client features, such as conversation search and prompt templates. This project was built with the anticipation of the official ChatGPT API from OpenAI, and now uses it along with the free access method. Through this clone, you can avoid subscription-based models in favor of free or pay-per-call APIs. I will most likely not deploy this app, as it's mainly a learning experience, but feel free to clone or fork to create your own custom wrapper. + Assistant AIs are the future and OpenAI revolutionized this movement with ChatGPT. While numerous methods exist to integrate these AIs, this app commemorates the original styling of ChatGPT, with the ability to integrate any current/future AI models through user-provided API keys, while improving upon original client features, such as conversation search and prompt templates. This project was built with the anticipation of the official ChatGPT API from OpenAI, and now uses it along with the free access method. Through this clone, you can avoid subscription-based models in favor of free or pay-per-call APIs. I will deploy a demo of this app, but feel free to clone or fork to create your own custom wrapper. Currently dockerized. ## Updates
+2023-03-06 +Due to more interest in this repo, I've dockerized the app as of this update for quick setup! See setup instructions below. I realize this still takes some time with installing docker dependencies, so it's on the roadmap to have a deployed demo. Besides this, I've made major improvements for a lot of the existing features across the board, mainly UI/UX. +
+
2023-03-04 Custom prompt prefixing and labeling is now supported through the official API. This nets some interesting results when you need ChatGPT for specific uses or entertainment. Select 'CustomGPT' in the model menu to configure this, and you can choose to save the configuration or reference it by conversation. Model selection will change by conversation.
@@ -56,7 +60,7 @@ Here are my planned/recently finished features. - [x] Customize prompt prefix/label (custom ChatGPT using official API) - [x] AI model change handling (start new convos within existing convo) - [x] Server convo pagination (limit fetch and load more with 'show more' button) -- [ ] Config file for easy startup +- [x] Config file for easy startup (docker compose) - [ ] Conversation Search (by title) - [ ] Resubmit/edit sent messages - [ ] Semantic Search Option (requires more tokens) @@ -64,6 +68,7 @@ Here are my planned/recently finished features. - [ ] Prompt Templates/Search - [ ] Refactor/clean up code (tech debt) - [ ] Mobile styling (half-finished) +- [ ] Deploy demo ### Features diff --git a/docker-compose.yml copy.example b/docker-compose.yml similarity index 96% rename from docker-compose.yml copy.example rename to docker-compose.yml index 6e05fb65a8..c9402b99e5 100644 --- a/docker-compose.yml copy.example +++ b/docker-compose.yml @@ -19,7 +19,7 @@ services: environment: - PORT=3080 - MONGO_URI=mongodb://mongodb:27017 - - OPENAI_KEY= + - OPENAI_KEY="" - CHATGPT_TOKEN="" - BING_TOKEN="" ports: