You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A basic authentication starter kit using [Laravel](https://laravel.com/docs/master), [Intertia.js](https://inertiajs.com/), [PrimeVue](https://primevue.org/) components, and [Tailwind CSS](https://tailwindcss.com/). An equivalent to using [Laravel Breeze](https://laravel.com/docs/master/starter-kits#laravel-breeze), but with the added benefit of all the PrimeVue components at your disposal.
9
8
@@ -23,18 +22,42 @@ Do you need a separate Vue SPA front-end instead of using Inertia.js? Consider u
23
22
24
23
## Theme
25
24
26
-
This starter kit provides a light/dark mode toggle by default, and custom theme functionality provided by the powerful **PrimeVue V4** theming system, using styled mode and custom design token values.
25
+
This starter kit features a built-in light/dark mode toggle along with a collection of custom theme presets built using the powerful **PrimeVue V4** theming system. It leverages styled mode and custom design token values to create flexible and cohesive UI designs.
26
+
27
+
### Prebuilt Theme Presets
28
+
29
+
The prebuilt theme presets are located in the `/resources/js/theme` directory. Each preset offers a distinct visual style:
30
+
31
+
-**noir**
32
+
A minimal, monochromatic theme that serves as the default style.
33
+
34
+
-**bootstrap**
35
+
Emulates the familiar look and feel of [Bootstrap](https://getbootstrap.com/).
27
36
28
-
The starting point for customizing your theme will be the `resources/js/theme-preset.js` module file. To quickly change the look and feel of your site, swap the [primary](https://primevue.org/theming/styled/#primary) values with a different set of [colors](https://primevue.org/theming/styled/#colors), change the [surface](https://primevue.org/theming/styled/#surface)`colorScheme` values (slate, gray, neutral, etc.), or completely change the [preset theme](https://primevue.org/theming/styled/#presets) (Aura used by default).
37
+
-**breeze**
38
+
Captures the aesthetic of [Laravel Breeze](https://laravel.com/docs/master/starter-kits#laravel-breeze).
29
39
30
-
Please reference the [PrimeVue Styled Mode Docs](https://primevue.org/theming/styled/) to fully understand how this system works, and how to further customize your theme to make it your own.
40
+
-**enterprise**
41
+
Provides a clean, no-nonsense corporate design.
42
+
43
+
### Customizing Your Own Theme
44
+
45
+
Creating your own theme preset is simple. You can:
46
+
47
+
- Swap the [primary](https://primevue.org/theming/styled/#primary) values with a different set of [colors](https://primevue.org/theming/styled/#colors).
48
+
- Adjust the `colorScheme`[surface](https://primevue.org/theming/styled/#surface) values (e.g., slate, gray, neutral).
49
+
- Change the extended [preset theme](https://primevue.org/theming/styled/#presets).
50
+
51
+
For detailed guidance on customization, please refer to the [PrimeVue Styled Mode Docs](https://primevue.org/theming/styled/).
31
52
32
53
## PrimeVue v4 w/ Tailwind CSS
33
54
34
55
If you have used a previous version of this project using **PrimeVue V3**, you'll know that [PrimeFlex](https://primeflex.org/) was used instead of [Tailwind CSS](https://tailwindcss.com/) for utility class styling. With V4 however, the PrimeTek team has officially suggested [Moving from PrimeFlex to Tailwind CSS](https://primevue.org/guides/primeflex/).
35
56
36
57
For this reason PrimeFlex has been removed, and Tailwind has been added into the project, along with the [tailwindcss-primeui](https://primevue.org/tailwind/#plugin) plugin. CSS layers have also been implemented so the Tailwind utilities can [override](https://primevue.org/tailwind/#override) the PrimeVue component styling when needed.
37
58
59
+
To clarify, Tailwind is **not** used for any component styling in this starter kit; instead, we use PrimeVue's styled mode with a custom theme preset implementation for component styling. Tailwind is applied solely for layout purposes **around** PrimeVue components and for minimal styling when needed.
60
+
38
61
---
39
62
40
63
## Usage with Docker
@@ -54,7 +77,7 @@ This starter kit is configured to use Docker Compose for local development with
54
77
```env
55
78
# Use any desired domain ending with .localhost
56
79
# Match with value used in docker-compose.local.yml
57
-
APP_URL=http://primevue-inertia.localhost
80
+
APP_URL=http://inertia-primevue.localhost
58
81
59
82
DB_CONNECTION=pgsql
60
83
DB_HOST=pgsql # name of service
@@ -63,7 +86,7 @@ This starter kit is configured to use Docker Compose for local development with
63
86
DB_USERNAME=sail
64
87
DB_PASSWORD=password
65
88
66
-
# Update port values as needed when running multiple projects
89
+
# Update port values as needed when running multiple projects/services
0 commit comments