diff --git a/README.md b/README.md index d1863ddd..42eb8c4c 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,74 @@ # GPT-4 Playground -Just got your GPT-4 API Key and want to give it a spin? Look not further! This project is mainly targeted to allow you to test out your Open AI API keys. The current OpenAI Playground still only allows 4096 tokens for 8k or 32k models like GPT-4 and if you would like to test out you key in a rendered chat environment you would have to purchase ChatCPT Plus. This project should fix both of those issues without comprimising on either experience. The project aims to preserve as much of the vanilla experience as possible while also providing a link between the the playground and ChatGPT to enable a better developer experience. +Just got your GPT-4 API key and want to give it a spin? Look no further! -As a side note, all API keys are encrypted and stored in your browser's local storage, so you can use this project without having to worry about your API key being stolen. +This project is designed to help you **test your OpenAI API key** in a ChatGPT-style environment — **without** needing ChatGPT Plus and **without** hitting token limits like on the official OpenAI Playground (which still maxes out at 4096 tokens, even for 8k or 32k GPT-4 models). -## Demo +The goal is to give you a smooth developer experience by blending the feel of the official ChatGPT with the flexibility of the Playground. + +--- + +🔐 **Privacy Note:** +Your API key is **encrypted** and **stored only in your browser’s local storage** — so you don’t need to worry about it being sent anywhere or getting stolen. + +--- + +## 🚀 Demo ### Mock ChatGPT Environment -This environment has most of the critical features like conversation history (which is stored locally), prompting, and multiple conversations. This environment is a great way to test out your API key and see how it works! + +This environment includes key features like: + +* Conversation history (stored locally) +* Prompting +* Multiple conversations + +It’s a great way to test out your API key and get a feel for GPT-4's capabilities! + ![ChatGpt-4 ChatGPT](https://i.imgur.com/DfTbV9d.png) +--- + ### Playground Environment + +A simpler playground interface that’s helpful for quick testing and debugging. + ![ChatGpt-4 Playground](https://i.imgur.com/DS6NPH2.png) -## Running Locally -To run this project locally, you will need to have [Node.js](https://nodejs.org/en/) installed. Once you have Node.js installed, you can clone this repository and run the following commands: +--- + +## 🛠️ Running Locally + +To get started, make sure you have [Node.js](https://nodejs.org/en/) installed. + +Then follow these steps: ```bash +# Clone the repository +git clone https://github.com/your-username/gpt4-playground.git +cd gpt4-playground + +# Install dependencies yarn install + +# Start the local development server yarn dev ``` -This will start a local server on port 3000. You can then navigate to `localhost:3000` to view the project! +Now, open your browser and visit: +👉 `http://localhost:3000` + +--- + +## 🤝 Contributing + +This project is still a work in progress — **and your help is welcome**! + +If you notice bugs or want to add improvements: + +* Open an issue +* Submit a pull request -## Contributing +> ⚠️ Note: This was built pretty quickly, so there might be some rough edges. Feedback is super appreciated! -**This project is still in development! Contributions are very much appreciated!** -If you would like to contribute to this project, please feel free to open a pull request or an issue, I hashed this project out in a few hours so there are bound to be some bugs!