From 4da8f795207b875d0142a61c00affbde4d8b5dd0 Mon Sep 17 00:00:00 2001 From: Austin Hornhead Date: Thu, 23 May 2024 18:52:32 +0200 Subject: [PATCH] chore: Update README with information about required environment variables Signed-off-by: Austin Hornhead --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 767940b..d9d803b 100644 --- a/README.md +++ b/README.md @@ -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