diff --git a/.env.example b/.env.example index b8f6293..3c45061 100644 --- a/.env.example +++ b/.env.example @@ -10,3 +10,10 @@ NEXTAUTH_URL=http://localhost:3000 ## Create a GitHub OAuth app here: https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app AUTH_GITHUB_ID=XXXXXXXX AUTH_GITHUB_SECRET=XXXXXXXX + +# instructions to create kv database here: https://vercel.com/docs/storage/vercel-kv/quickstart and +KV_URL=XXXXXXXX +KV_REST_API_URL=XXXXXXXX +KV_REST_API_TOKEN=XXXXXXXX +KV_REST_API_READ_ONLY_TOKEN=XXXXXXXX + diff --git a/README.md b/README.md index 62960c7..cb32307 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,13 @@ You can deploy your own version of the Next.js AI Chatbot to Vercel with one cli [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?demo-title=Next.js+Chat&demo-description=A+full-featured%2C+hackable+Next.js+AI+chatbot+built+by+Vercel+Labs&demo-url=https%3A%2F%2Fchat.vercel.ai%2F&demo-image=%2F%2Fimages.ctfassets.net%2Fe5382hct74si%2F4aVPvWuTmBvzM5cEdRdqeW%2F4234f9baf160f68ffb385a43c3527645%2FCleanShot_2023-06-16_at_17.09.21.png&project-name=Next.js+Chat&repository-name=nextjs-chat&repository-url=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fai-chatbot&from=templates&skippable-integrations=1&env=OPENAI_API_KEY%2CAUTH_GITHUB_ID%2CAUTH_GITHUB_SECRET&envDescription=How+to+get+these+env+vars&envLink=https%3A%2F%2Fgithub.com%2Fvercel-labs%2Fai-chatbot%2Fblob%2Fmain%2F.env.example&teamCreateStatus=hidden&stores=[{"type":"kv"}]) +## Creating a KV Database Instance + +Follow the steps outlined in the [quick start guide](https://vercel.com/docs/storage/vercel-kv/quickstart#create-a-kv-database) provided by Vercel. This guide will assist you in creating and configuring your KV database instance on Vercel, enabling your application to interact with it. + +Remember to update your environment variables (`KV_URL`, `KV_REST_API_URL`, `KV_REST_API_TOKEN`, `KV_REST_API_READ_ONLY_TOKEN`) in the `.env` file with the appropriate credentials provided during the KV database setup. + + ## Running locally You will need to use the environment variables [defined in `.env.example`](.env.example) to run Next.js AI Chatbot. It's recommended you use [Vercel Environment Variables](https://vercel.com/docs/concepts/projects/environment-variables) for this, but a `.env` file is all that is necessary.