From 0ddc1e8ad6cfcceedea8d3c2b8ac339e4a0b73d6 Mon Sep 17 00:00:00 2001 From: ChenZhaoYu <790348264@qq.com> Date: Thu, 9 Feb 2023 15:57:39 +0800 Subject: [PATCH] chore: README --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) 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 -# 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 ```