Skip to content

Kl/scrum 184 update readme #153

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kevin-lann merged 1 commit into from
Apr 4, 2025
Merged

Kl/scrum 184 update readme #153

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,13 @@ DATABASE_KEY=[Insert Supabase Project API key]
OPENAI_API_KEY=[Insert OpenAI API Key]
PINECONE_API_KEY=[Insert Pinecone API Key]
PINECONE_INDEX_NAME="course-matrix"

BREVO_API_KEY=[Insert Brevo API Key]
SENDER_EMAIL="[email protected]"
SENDER_NAME="Course Matrix Notifications"
```

The `DATABASE_URL` variable should contain your Supabase project url and the `DATABASE_KEY` should contain your Supabase project’s API key. To learn how to create a new Supabase project: see [here](https://medium.com/@heshramsis/building-a-crud-app-with-supabase-and-express-a-step-by-step-guide-for-junior-developers-81456b850910). Likewise, the `OPENAI_API_KEY` variable should contain your OpenAI Project API Key and the `PINECONE_API_KEY` should contain your Pinecone Project API Key. Note that for the purposes of this project, **we will provide the grader with all necessary API keys and URLs**.
The `DATABASE_URL` variable should contain your Supabase project url and the `DATABASE_KEY` should contain your Supabase project’s API key. To learn how to create a new Supabase project: see [here](https://medium.com/@heshramsis/building-a-crud-app-with-supabase-and-express-a-step-by-step-guide-for-junior-developers-81456b850910). Likewise, the `OPENAI_API_KEY` variable should contain your OpenAI Project API Key, the `PINECONE_API_KEY` should contain your Pinecone Project API Key, and the `BREVO_API_KEY` should contain your Brevo API Key. Note that for the purposes of this project, **we will provide the grader with all necessary API keys and URLs**.

4. Configure environment variables for frontend. Create a `.env` file in `/frontend` and populate it with the following:

Expand Down