Compare commits

...

3 commits

Author SHA1 Message Date
Benjamin Nussbaum
4e3b47e4eb
Update README.md
Some checks are pending
tests / ci (push) Waiting to run
2025-08-17 11:06:29 +02:00
Kyle Carter
888b61a575 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.
2025-08-17 10:59:56 +02:00
Angel J
fdf8031d08 docs: clarify local development setup and add missing steps 2025-08-17 10:59:47 +02:00
2 changed files with 13 additions and 3 deletions

View file

@ -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` | Default timezone, which will be used by the PHP date functions | UTC |
#### Login

View file

@ -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