Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
voidgraphics authored Mar 17, 2022
1 parent 92dc2d1 commit fe1f787
Showing 1 changed file with 67 additions and 5 deletions.
72 changes: 67 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,84 @@ 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
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
```

0 comments on commit fe1f787

Please sign in to comment.