Niek / chatgpt-web

ChatGPT web interface using the OpenAI API
https://niek.github.io/chatgpt-web/
GNU General Public License v3.0
1.85k stars 464 forks source link

ChatGPT-web

GitHub Workflow Status JavaScript Style Guide GitHub All Contributors

URL: https://niek.github.io/chatgpt-web/

Screenshot of ChatGPT-web

ChatGPT-web is a simple one-page web interface to the OpenAI ChatGPT API. To use it, you need to register for an OpenAI API key first. All messages are stored in your browser's local storage, so everything is private. You can also close the browser tab and come back later to continue the conversation.

Features

Development and Building

Here’s how to participate in development and prepare your build for production:

Setting Up and Running the Development Server

To install dependencies and start the development server:

npm ci
npm run dev

Preparing the Production Build

To compile the project for production, ensuring optimal performance:

npm run build

This command generates a dist folder containing the production build of your project, ready for deployment.

Incorporating Awesome ChatGPT Prompts

The Awesome ChatGPT Prompts repository is a treasure trove of prompt examples designed for use with the ChatGPT model. This collection can inspire new conversations or expand existing ones with the model. Get involved by adding your prompts or utilizing the repository to inspire your contributions:

To update and integrate the latest prompts from the repository into your project, run:

git subtree pull --prefix src/awesome-chatgpt-prompts https://github.com/f/awesome-chatgpt-prompts.git main --squash

This command synchronizes the latest set of prompts into your project's src/awesome-chatgpt-prompts/ directory, fostering an environment of continuous innovation and expansion.

Using Docker Compose for Local Deployment

Deploying the application and its mocked API locally is streamlined using Docker Compose. By executing the following command, you initialize both services effortlessly:

docker compose up -d

Accessing the Local Web Service

Upon successfully running the Docker Compose command, the local version of the web service becomes accessible. You can interact with it by visiting: http://localhost:5173/

Mocked API Usage

For instances where immediate API responses are preferred, consider utilizing the mocked API. Follow the steps below to configure and customize your mocked API responses:

Desktop app

To use ChatGPT-web as a desktop application:

Contributors

Michael Tanzer
Michael Tanzer

πŸ€” πŸ’»
Peter
Peter

πŸ€”
Dan Brown
Dan Brown

πŸ€” πŸ’»
littlemoonstones
littlemoonstones

πŸ’» πŸ€”
maxrye1996
maxrye1996

πŸ›
Mikemansour
Mikemansour

πŸ€”
abc91199
abc91199

πŸ€”
fuegovic
fuegovic

πŸ€”
Sixzeroo
Sixzeroo

πŸ’»
terryoy
terryoy

πŸ€” πŸ’»
Yang Lyu
Yang Lyu

πŸ›
ryanhex53
ryanhex53

πŸ’» 🎨
Emil Elgaard
Emil Elgaard

πŸ€” 🎨 πŸ’»
felixschwamm
felixschwamm

πŸ’» πŸ€”
Webifi
Webifi

πŸ’» πŸ€”
Daniel Dengler
Daniel Dengler

πŸ’»
Ashkan
Ashkan

πŸ’»
antopoid
antopoid

πŸ“–
MitchBoss
MitchBoss

πŸ’»
Ikko Eltociear Ashimine
Ikko Eltociear Ashimine

πŸ“–
Jackson Stewart
Jackson Stewart

πŸ›
Niel Thiart
Niel Thiart

πŸ’»
Maksim Misin
Maksim Misin

πŸ’»
romain.wg
romain.wg

πŸ“–
Morgan
Morgan

πŸ’»
Udon
Udon

🎨