Skip to content

Commit

Permalink
docs: Add configuration instructions to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SverreNystad committed May 11, 2024
1 parent 051cfc1 commit 6608f0a
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- [Quick Start](#quick-start)
- [Prerequisites](#prerequisites)
- [Clone the repository](#clone-the-repository)
- [Configuration](#configuration)
- [Usage](#usage)
- [📖 Documentations](#-documentations)
- [Contributors](#contributors)
Expand Down Expand Up @@ -55,6 +56,21 @@ git clone https://github.com/CogitoNTNU/TutorAI.git
cd TutorAI
```

### Configuration
Create a `.env` file in the root directory of the project and add the following environment variables:

```bash
OPENAI_API_KEY = 'your_openai_api_key'
MONGODB_URI = 'your_secret_key'
```

Optionally, you can add the following environment variables to customize the project:

```bash
GPT_MODEL = 'gpt-3.5-turbo' # OpenAI model to use
```


### Usage
To start TutorAI, run the following command in the root directory of the project:

Expand Down

0 comments on commit 6608f0a

Please sign in to comment.