Skip to content

Commit

Permalink
Add documentation for OpenAI feature
Browse files Browse the repository at this point in the history
  • Loading branch information
markwitt1 committed Apr 26, 2024
1 parent 5b55a08 commit bc2a008
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
4 changes: 3 additions & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@ NEXT_PUBLIC_POSTHOG_KEY=
NEXT_PUBLIC_POSTHOG_HOST=

NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=
NEXT_PUBLIC_SUPABASE_ANON_KEY=

OPENAI_API_KEY=
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ For user authentication, the project uses Supabase.

For analytics, the project uses PostHog.

To explain questions, the project uses the OpenAI API.

You will need to create accounts for these services and set up projects to get the required environment variables.

## Environment Variables
Expand All @@ -81,6 +83,8 @@ The following environment variables are required:
- `NEXT_PUBLIC_POSTHOG_API_KEY`: The API key for your PostHog project.
- `NEXT_PUBLIC_POSTHOG_HOST`: The host for your PostHog project.

- `OPENAI_API_KEY`: The API key for the OpenAI API.

Create a `.env.local` file at the root of the project and add these variables to it.

## Installation
Expand Down

0 comments on commit bc2a008

Please sign in to comment.