mkrieger/byos_laravel
1
0
Fork 0
mirror of https://github.com/usetrmnl/byos_laravel.git synced 2026-01-13 15:07:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: clarify local development setup and add missing steps

Browse source
This commit is contained in:
Angel J 2025-08-16 17:45:32 -07:00 • committed by angel
parent ba3bf31bb7
commit ee55e73e75
1 changed files with 12 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/DEVELOPMENT.md
View file

@ -1,4 +1,4 @@
### Local Development ## Local Development
#### Requirements #### Requirements
@ -19,11 +19,12 @@ cp .env.example .env
php artisan key:generate php artisan key:generate
``` ```
#### Install dependencies #### Install dependencies and Build frontend
```bash ```bash
composer install composer install
npm i npm i
npm run build
``` ```
#### Run migrations #### Run migrations
@ -32,6 +33,12 @@ npm i
php artisan migrate --seed php artisan migrate --seed
``` ```
#### Link storage to expose public assets
```bash
php artisan storage:link
```
#### Run the server #### Run the server
To expose the built-in server to the local network, you can run the following command: 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 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. Use the provided Dockerfile, or docker-compose file to run the server in a container.
#### .devcontainer #### .devcontainer