From fe1f787e446b99c6baa96a281819001a1391100d Mon Sep 17 00:00:00 2001 From: Adrien Leloup Date: Thu, 17 Mar 2022 16:51:35 +0100 Subject: [PATCH] Update README.md --- README.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 67 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 46baaf1..cc94c1d 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,28 @@ This preset will install and setup everything that is needed for new Laravel pro To start a new project: -``` -// Creating the new Laravel project +1. Create the new Laravel project + +```shellsession laravel new my-project cd my-project +``` -// Installing the preset +2. Install the preset + +```shellsession composer require whitecube/laravel-preset +``` -// Activating the preset +3. Activate the preset + +```shellsession php artisan ui whitecube +``` + +4. You're done! You can now compile, watch, etc! -// You're done! You can now compile, watch, etc! +```shellsession yarn dev yarn watch yarn icons @@ -23,3 +33,55 @@ yarn watch-icons ``` Everything you'd expect should be there, and you can get to work right away. + +## Setting up new Hiker projects + +After doing the above commands, do the following: + +1. In `composer.json`, add the hiker and trail repositories: + +```json +{ + "repositories": { + "hiker": { + "type": "vcs", + "url": "https://github.com/whitecube/hiker.git" + }, + "trail": { + "type": "vcs", + "url": "https://github.com/whitecube/trail.git" + } + } +} +``` + +2. Create a `composer.local.json` file containing: + +```json +{ + "repositories": { + "hiker": { + "type": "path", + "url": "../hiker/", + "options": { + "symlink": true + } + }, + "trail": { + "type": "path", + "url": "../trail/", + "options": { + "symlink": true + } + } + } +} +``` + +3. Run the following terminal commands in the project's folder + +```shellsession +composer require whitecube/hiker +php artisan hiker:install +``` +