diff --git a/README.md b/README.md index 2c743a8..a91519e 100644 --- a/README.md +++ b/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 +pnpm install +``` + +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 -# 1. run service pnpm run service +``` -# 2. run web +Run web +```shell pnpm run dev ```