diff --git a/README.md b/README.md index 95ed5c8..73b9a6b 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` | Default timezone, which will be used by the PHP date functions | UTC | #### Login 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