From 7fc22771e567a62d3cb1884d3d2546b2ce16993a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Kr=C3=BChlmann?= Date: Mon, 5 Jan 2026 14:09:36 +0100 Subject: [PATCH] Add documentation for .env file for development --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 64e140e..6b09266 100644 --- a/README.md +++ b/README.md @@ -22,3 +22,13 @@ Optional: | Variable | Description | Example Value | |----------|-------------|---------------| | TWITCH_REDIRECT_URI | Override default redirect URI | http://localhost:8080/login/oauth2/code/twitch | + +During development environment variables can be placed in the `.env` file at the project root to automatically load them. Be aware that these are only loaded when using the [Makefile](./Makefile) command `make run`. + +If you want to use the default development setup your `.env` file should look like this: + +```sh +TWITCH_CLIENT_ID=... +TWITCH_CLIENT_SECRET=... +IMGFLOAT_INITIAL_TWITCH_USERNAME_SYSADMIN=... +```