updated readme with first steps

tobischulz · Jan 1, 2024 · 64ea103 · 64ea103
1 parent 27e14fe
commit 64ea103
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 2 deletions.
diff --git a/.env.example b/.env.example
@@ -2,7 +2,7 @@ APP_NAME="Laravel Fortify SPA"
 APP_ENV=local
 APP_KEY=
 APP_DEBUG=true
-APP_URL=http://localhost
+APP_URL=http://localhost # set this to your local domain
 
 LOG_CHANNEL=stack
 LOG_DEPRECATIONS_CHANNEL=null
@@ -22,7 +22,7 @@ QUEUE_CONNECTION=sync
 SESSION_DRIVER=file
 SESSION_LIFETIME=120
 SESSION_SECURE_COOKIE=false
-SESSION_DOMAIN=localhost
+SESSION_DOMAIN=localhost # set this to your local domain
 
 MEMCACHED_HOST=127.0.0.1
 

diff --git a/README.md b/README.md
@@ -28,6 +28,23 @@ The following Sanctum and Fortify features are implemented in this Vue SPA:
 - ✅ Two Factor Authentication with Confirmation
 - ✅ E-Mail Verification
 
+## Getting started
+
+Take this steps:
+
+- git clone
+- run `composer install`
+- run `yarn`
+- copy .env.example to .env
+- modify .env file
+
+Make sure to set those two variables to your current domain or localhost:
+
+```
+APP_URL=http://laravel-vue-spa-boilerplate.test
+SESSION_DOMAIN=laravel-vue-spa-boilerplate.test
+```
+
 ## Screenshots
 
 A Picture Is Worth More Than A Thousand Words.