From 75de5f917113b1e526a00b6c2789e3cebb1511ee Mon Sep 17 00:00:00 2001 From: Benjamin Takats Date: Wed, 30 Nov 2022 16:37:56 +0100 Subject: [PATCH] update README.md --- README.md | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 39fe17c9..e64aaf71 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,33 @@ [![Laravel Forge Site Deployment Status](https://img.shields.io/endpoint?url=https%3A%2F%2Fforge.laravel.com%2Fsite-badges%2F03a51b88-6eab-491b-8b80-5183a78d0024%3Fdate%3D1%26commit%3D1&style=for-the-badge)](https://forge.laravel.com) -## About +## Development -WIP +### Installation + +```cp .env.example .env``` + +```composer install``` +*(you need a valid Laravel Nova license)* + +#### Start docker development containers + +```vendor/bin/sail up -d``` + +#### Install node dependencies + +```vendor/bin/sail yarn install``` + +#### Start compiling watcher + +```vendor/bin/sail yarn dev``` + +#### Compile assets + +```vendor/bin/sail yarn build``` + +#### Update dependencies + +```vendor/bin/sail yarn install``` ## Contributing @@ -10,7 +35,8 @@ WIP ## Security Vulnerabilities -If you discover a security vulnerability within Laravel, please send an e-mail to Benjamin Takats via [bt@affekt.de](mailto:bt@affekt.de). All security vulnerabilities will be promptly addressed. +If you discover a security vulnerability within Laravel, please send an e-mail to Benjamin Takats +via [bt@affekt.de](mailto:bt@affekt.de). All security vulnerabilities will be promptly addressed. ## License