chore: README
This commit is contained in:
parent
cd36072d6a
commit
0ddc1e8ad6
27
README.md
27
README.md
|
@ -3,17 +3,28 @@
|
|||
This is a ChatGPT web application demo with express and vue3
|
||||
|
||||
![cover](./docs/cover.png)
|
||||
## Intro
|
||||
1. `node >= 18`
|
||||
1. `pnpm install` node deps
|
||||
2. set `OPENAI_API_KEY` in `.env`
|
||||
## Usage
|
||||
> Make sure `node >= 18`
|
||||
|
||||
## Run
|
||||
install node deps
|
||||
```shell
|
||||
# 1. run service
|
||||
pnpm run service
|
||||
pnpm install
|
||||
```
|
||||
|
||||
# 2. run web
|
||||
Sign up for an [OpenAI API key](https://platform.openai.com/overview) and store it in your environment.
|
||||
|
||||
```
|
||||
# .env
|
||||
OPENAI_API_KEY="Your Key"
|
||||
```
|
||||
|
||||
Run service
|
||||
```shell
|
||||
pnpm run service
|
||||
```
|
||||
|
||||
Run web
|
||||
```shell
|
||||
pnpm run dev
|
||||
```
|
||||
|
||||
|
|
Loading…
Reference in New Issue