Skip to content

Commit

Permalink
chore: Update README with information about required environment vari…
Browse files Browse the repository at this point in the history
…ables

Signed-off-by: Austin Hornhead <augustthegreat.cool@gmail.com>
  • Loading branch information
marchingon12 committed May 23, 2024
1 parent f870609 commit 4da8f79
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 @@ -73,6 +73,22 @@ bun run preview
For more options, see the [Vite guide][vite-guide].


### Environments

You'll be requiring two environmaent variables:

```env
VITE_GITHUB_TOKEN='your_github_token'
VITE_MODE=dev
```

- Your Github Personal Access Token is required for fetching from Github's API with lower rate limits.
- The mode needs to be set in order for the proxies in `vite.config.js` to function properly.

>[!Note]
>
>These environment variables aren't needed in the production build as a separate file! Use Github Action's environmental secrets to add your variables.
[bun]: https://bun.sh/
[shadcnui]: https://github.com/shadcn-ui/ui
[vite-guide]: https://vitejs.dev/guide/build

0 comments on commit 4da8f79

Please # to comment.