From fdf8031d089d2566506029736be5ab37182c7b1f Mon Sep 17 00:00:00 2001 From: Angel J <78835633+Iamanaws@users.noreply.github.com> Date: Sat, 16 Aug 2025 17:45:32 -0700 Subject: [PATCH 1/3] docs: clarify local development setup and add missing steps --- docs/DEVELOPMENT.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index c7bca71..07ec847 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -1,4 +1,4 @@ -### Local Development +## Local Development #### Requirements @@ -19,11 +19,12 @@ cp .env.example .env php artisan key:generate ``` -#### Install dependencies +#### Install dependencies and Build frontend ```bash composer install npm i +npm run build ``` #### Run migrations @@ -32,6 +33,12 @@ npm i php artisan migrate --seed ``` +#### Link storage to expose public assets + +```bash +php artisan storage:link +``` + #### Run the server To expose the built-in server to the local network, you can run the following command: @@ -40,7 +47,9 @@ To expose the built-in server to the local network, you can run the following co php artisan serve --host=0.0.0.0 --port 4567 ``` -### Docker +--- + +## Docker Use the provided Dockerfile, or docker-compose file to run the server in a container. #### .devcontainer From 888b61a5756bd53cf66da9b3432832a0c89ac559 Mon Sep 17 00:00:00 2001 From: Kyle Carter Date: Sat, 16 Aug 2025 21:25:18 -0600 Subject: [PATCH 2/3] Add mention of APP_TIMEZONE to README I lost more time than I care to admit trying to track this down. Putting it as part of the documentation should hopefully help others in the future. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 95ed5c8..4b4ef26 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,7 @@ php artisan db:seed --class=ExampleRecipesSeeder | `FORCE_HTTPS` | If your server handles SSL termination, enforce HTTPS. | 0 | | `PHP_OPCACHE_ENABLE` | Enable PHP Opcache | 0 | | `TRMNL_IMAGE_URL_TIMEOUT` | How long TRMNL waits for a response on the display endpoint. (sec) | 30 | +| `APP_TIMEZONE` | The timezone that the system should run under (Affects "Sleep Mode" | UTC | #### Login From 4e3b47e4eb39763ef96db08fcb4b31b9c27bc701 Mon Sep 17 00:00:00 2001 From: Benjamin Nussbaum Date: Sun, 17 Aug 2025 11:06:29 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b4ef26..73b9a6b 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ php artisan db:seed --class=ExampleRecipesSeeder | `FORCE_HTTPS` | If your server handles SSL termination, enforce HTTPS. | 0 | | `PHP_OPCACHE_ENABLE` | Enable PHP Opcache | 0 | | `TRMNL_IMAGE_URL_TIMEOUT` | How long TRMNL waits for a response on the display endpoint. (sec) | 30 | -| `APP_TIMEZONE` | The timezone that the system should run under (Affects "Sleep Mode" | UTC | +| `APP_TIMEZONE` | Default timezone, which will be used by the PHP date functions | UTC | #### Login