Skip to content

Commit b573417

Browse files
committed
update README to clarify GitHub token setup and add placeholder for OpenAI key
1 parent 5ef9326 commit b573417

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

api/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ NODE_ENV=development
2424
Keep in mind that you have limited calls to the GitHub API (60 calls per hour). The [FetchService](./api/src/fetch/service.ts) does a great job of caching these calls so it doesn't unnecessarily consume the GitHub API quota. If you wish to extend the limit from 60 to 5000, simply create a [GitHub Personal Access Token](https://github.com/settings/tokens) (make sure it has `Access public repositories` checked), and set it in `./api/.env` like this:
2525

2626
```.env
27-
GITHUB_TOKEN=Paste_Your_Token_Here
27+
GITHUB_TOKEN=Paste_your_token_here
2828
NODE_ENV=development
29+
OPENAI_KEY=Pase_your_key_here
2930
```
3031

3132
**Note:** If the README is still unclear, please create a PR with your suggested changes/additions.

api/src/config/types.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,5 +42,5 @@ export class EnvRecord {
4242
MEILISEARCH_MASTER_KEY = "default";
4343

4444
@IsString()
45-
OPENAI_KEY!: string;
45+
OPENAI_KEY = "no-key";
4646
}

0 commit comments

Comments
 (0)