-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
28 changed files
with
1,317 additions
and
187 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,11 +20,11 @@ npm install | |
|
||
## Setup | ||
### Environment file | ||
#### Backend | ||
1. Copy the example environment file `.env.example` in the backend directory and rename it to `.env`. | ||
1. Replace the OPENAI_API_KEY value in the `.env` file with your [OpenAI API key](https://platform.openai.com/account/api-keys). | ||
1. Replace the SESSION_SECRET value with a [random UUID](https://www.uuidgenerator.net/). | ||
|
||
|
||
| env var | default | description | | ||
| ------------------------------- | ------- | ----------- | | ||
| OPENAI_API_KEY | YOUR_API_KEY | API key used to authenticate the user when using the OpenAI API. | | ||
|
@@ -35,6 +35,13 @@ npm install | |
| EMAIL_WHITELIST | [email protected],[email protected],@scottlogic.com | List of emails that the chat bot can 'send' emails to when the EMAIL_WHITELIST defence is active. | | ||
| SESSION_SECRET | YOUR_SESSION_SECRET | A secret string used to set up the backend user session. | | ||
|
||
#### Frontend | ||
1. Copy the example environment file `.env.example` in the frontend directory and rename it to `.env`. | ||
|
||
| env var | default | description | | ||
| ------------------------------- | ------- | ----------- | | ||
| VITE_BACKEND_URL | http://localhost:3001/ | The base URL to access the backend. | | ||
|
||
## Development | ||
### Linting and formatting | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
VITE_BACKEND_URL=http://localhost:3001/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.