Skip to content

Commit

Permalink
chore: Update README for v2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
sonngdev committed Mar 8, 2023
1 parent 7c942f7 commit 07bdeee
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API server for ChatGPT

Backend server for **ChatGPT With Voice**. You can check out [the website](https://chatgpt.sonng.dev/), or find the [frontend repo](https://github.com/thanhsonng/chatgpt-voice) on GitHub.
Backend server for **ChatGPT With Voice**, now using the ✨ official ChatGPT APIs ✨. You can check out [the website](https://chatgpt.sonng.dev/), or find the [frontend repo](https://github.com/thanhsonng/chatgpt-voice) on GitHub.

## Installation
Clone this repo.
Expand All @@ -9,18 +9,22 @@ Clone this repo.
git clone https://github.com/thanhsonng/chatgpt-server.git
```

Prepare environment variables by creating `.env` at the project root. You need to sign up for an OpenAI account [here](https://openai.com/api/), using email and password.
Prepare environment variables by creating `.env` at the project root. You need to sign up for an [OpenAI API Key](https://platform.openai.com/overview).

```t
PORT=8000 # Or whichever port available
OPENAI_EMAIL="<your-openai-email>"
OPENAI_PASSWORD="<your-openai-password>"
OPENAI_API_KEY="<your-openai-api-key>"
```

Start the server and you are done! Remember to use Node 18 or higher, this is the requirement of this package's core dependency – [`chatgpt`](https://github.com/transitive-bullshit/chatgpt-api).

```bash
npm install

# Run locally, or...
npm run dev

# Run on production
npm run build
npm run start
```
Expand Down

0 comments on commit 07bdeee

Please sign in to comment.