10000 Merge branch 'master' into vite · whitecube/laravel-preset@dfee1e1 · GitHub
[go: up one dir, main page]

Skip to content

Commit dfee1e1

Browse files
committed
Merge branch 'master' into vite
2 parents 12bd404 + bdcc332 commit dfee1e1

File tree

2 files changed

+21
-40
lines changed

2 files changed

+21
-40
lines changed

README.md

Lines changed: 18 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ cd my-project
1414
2. Install the preset
1515

1616
```shellsession
17-
composer require whitecube/laravel-preset
17+
composer require whitecube/laravel-preset --dev
1818
```
1919

2020
3. Activate the preset
@@ -38,53 +38,34 @@ Everything you'd expect should be there, and you can get to work right away.
3838

3939
After doing the above commands, do the following:
4040

41-
1. In `composer.json`, add the hiker and trail repositories:
41+
1. Add the Hiker repository to the `composer.json` file:
4242

43-
```json
44-
{
45-
"repositories": {
46-
"hiker": {
47-
"type": "vcs",
48-
"url": "https://github.com/whitecube/hiker.git"
49-
},
50-
"trail": {
51-
"type": "vcs",
52-
"url": "https://github.com/whitecube/trail.git"
53-
}
54-
}
55-
}
43+
```shellsession
44+
composer config repositories.hiker composer https://repo.hiker.dev
5645
```
5746

58-
2. Create a `composer.local.json` file containing:
47+
2. The, run the following terminal commands:
5948

60-
```json
61-
{
62-
"repositories": {
63-
"hiker": {
64-
"type": "path",
65-
"url": "../hiker/",
66-
"options": {
67-
"symlink": true
68-
}
69-
},
70-
"trail": {
71-
"type": "path",
72-
"url": "../trail/",
73-
"options": {
74-
"symlink": true
75-
}
76-
}
77-
}
78-
}
49+
```shellsession
50+
composer require hiker-dev/hiker
7951
```
8052

81-
3. Run the following terminal commands in the project's folder
53+
3. When prompted, add your Hiker.dev user & license. You can store these credentials in a `auth.json`, but don't forget to add this file to the project's `.gitignore`!
54+
55+
4. Finally, run Hiker's installation command:
8256

8357
```shellsession
84-
composer require whitecube/hiker
8558
php artisan hiker:install
8659
```
8760

61+
## Publish the base files for common components
62+
63+
This package ships with a set of publishable components that will help setup the project's front-end basics in a few seconds. The following command will prompt for the components you can install:
64+
65+
```shellsession
66+
php artisan publish:component
67+
````
68+
8869
## Creating new publishable components
8970

9071
In order to create a publishable component, one should simply create a new "Publisher" class inside `src/Components/Publishers` and implement `Whitecube\LaravelPreset\Components\PublisherInterface` :

composer.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@
2626
}
2727
],
2828
"require": {
29-
"php": "^8.0",
30-
"laravel/prompts": "^0.1.13",
31-
"laravel/ui": "^4.0"
29+
"php": "^8.3",
30+
"laravel/prompts": "^0.2.0",
31+
"laravel/ui": "^4.6"
3232
},
3333
"autoload": {
3434
"psr-4": {

0 commit comments

Comments
 (0)
0