mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-16 16:30:15 +01:00
Update README.md
organize readme for readability
This commit is contained in:
parent
350a1bbae0
commit
25fd39c2b9
1 changed files with 28 additions and 4 deletions
32
README.md
32
README.md
|
|
@ -16,10 +16,11 @@ https://user-images.githubusercontent.com/110412045/223754183-8b7f45ce-6517-4bd5
|
|||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><strong>Previous Updates</strong></summary>
|
||||
<details>
|
||||
<details>
|
||||
<details>
|
||||
|
||||
|
||||
<summary><strong>2023-03-20</strong></summary>
|
||||
|
||||
|
||||
|
|
@ -41,6 +42,7 @@ On that note, I had to switch the default branch due to some breaking changes th
|
|||
Full details and [example here](https://github.com/danny-avila/chatgpt-clone/releases/tag/v0.0.4). Message search is on the docket
|
||||
|
||||
</details>
|
||||
<details>
|
||||
<summary><strong>2023-03-12</strong></summary>
|
||||
|
||||
|
||||
|
|
@ -128,7 +130,10 @@ Currently, this project is only functional with the `text-davinci-003` model.
|
|||
|
||||
> This is a work in progress. I'm building this in public. FYI there is still a lot of tech debt to cleanup. You can follow the progress here or on my [Linkedin](https://www.linkedin.com/in/danny-avila).
|
||||
|
||||
Here are my recently completed and planned features:
|
||||
|
||||
|
||||
<details>
|
||||
<summary><strong>Here are my recently completed and planned features:</strong></summary>
|
||||
|
||||
- [x] Persistent conversation
|
||||
- [x] Rename, delete conversations
|
||||
|
|
@ -152,6 +157,8 @@ Here are my recently completed and planned features:
|
|||
- [ ] Optional use of local storage for credentials
|
||||
- [ ] Deploy demo
|
||||
|
||||
</details>
|
||||
|
||||
### Features
|
||||
|
||||
- Response streaming identical to ChatGPT through server-sent events
|
||||
|
|
@ -165,10 +172,19 @@ Here are my recently completed and planned features:
|
|||
|
||||
### Tech Stack
|
||||
|
||||
- Utilizes [node-chatgpt-api](https://github.com/waylaidwanderer/node-chatgpt-api)
|
||||
|
||||
<details>
|
||||
<summary><strong>This project uses:</strong></summary>
|
||||
|
||||
|
||||
|
||||
- [node-chatgpt-api](https://github.com/waylaidwanderer/node-chatgpt-api)
|
||||
- No React boilerplate/toolchain/clone tutorials, created from scratch with react@latest
|
||||
- Use of Tailwind CSS and [shadcn/ui](https://github.com/shadcn/ui) components
|
||||
- Docker, useSWR, Redux, Express, MongoDB, [Keyv](https://www.npmjs.com/package/keyv)
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
## Getting Started
|
||||
|
||||
|
|
@ -295,10 +311,16 @@ Please write me an express module, that serve the login and logout endpoint as a
|
|||
|
||||
|
||||
### Updating
|
||||
|
||||
- As the project is still a work-in-progress, you should pull the latest and run the steps over. Reset your browser cache/clear site data.
|
||||
|
||||
## Use Cases ##
|
||||
|
||||
|
||||
|
||||
<details>
|
||||
<summary><strong> Why use this project? </strong></summary>
|
||||
|
||||
- One stop shop for all conversational AIs, with the added bonus of searching past conversations.
|
||||
- Using the official API, you'd have to generate 7.5 million words to expense the same cost as ChatGPT Plus ($20).
|
||||
- ChatGPT/Google Bard/Bing AI conversations are lost in space or
|
||||
|
|
@ -315,6 +337,8 @@ Please write me an express module, that serve the login and logout endpoint as a
|
|||
|
||||

|
||||
|
||||
</details>
|
||||
|
||||
|
||||
## Origin ##
|
||||
This project was originally created as a Minimum Viable Product (or MVP) for the [@HackReactor](https://github.com/hackreactor/) Bootcamp. It was built with OpenAI response streaming and most of the UI completed in under 20 hours. During the end of that time, I had most of the UI and basic functionality done. This was created without using any boilerplates or templates, including create-react-app and other toolchains. I didn't follow any 'un-official chatgpt' video tutorials, and simply referenced the official site for the UI. The purpose of the exercise was to learn setting up a full stack project from scratch. Please feel free to give feedback, suggestions, or fork the project for your own use.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue