Skip to content
This repository was archived by the owner on Dec 11, 2021. It is now read-only.

Commit fd882cc

Browse files
committed
Update README.md
1 parent 9c525d5 commit fd882cc

File tree

8 files changed

+43
-1
lines changed

8 files changed

+43
-1
lines changed

README.md

Lines changed: 43 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,43 @@
1-
# Laravel preset for TailwindCSS
1+
# Laravel preset for TailwindCSS
2+
3+
A Laravel front-end scaffolding preset for [Tailwind CSS](https://tailwindcss.com) - a Utility-First CSS Framework for Rapid UI Development.
4+
5+
## Installation and usage
6+
This package requires Laravel 7.0 or higher.
7+
8+
1. Fresh install Laravel and `cd` to your app.
9+
2. Install `composer require tailwindcomponents/laravel-preset --dev`.
10+
11+
### a. For Presets without Authentication
12+
13+
1. Use `php artisan ui tailwindcss` for the basic Tailwind CSS preset
14+
2. `npm install && npm run dev`
15+
3. `php artisan serve` (or equivalent) to run server and test preset.
16+
17+
### b. For Presets with Authentication
18+
19+
1. Use `php artisan ui tailwindcss --auth` for the basic preset, auth route entry, and Tailwind CSS auth views in one go. (NOTE: If you run this command several times, be sure to clean up the duplicate Auth entries in `routes/web.php`)
20+
4. `npm install && npm run dev`
21+
5. Configure your favorite database (mysql, sqlite etc.)
22+
6. `php artisan migrate` to create basic user tables.
23+
7. `php artisan serve` (or equivalent) to run server and test preset.
24+
25+
### Config
26+
27+
The default `tailwind.config.js` configuration file included by this package simply uses the config from the Tailwind vendor files. Should you wish to make changes, you should remove the file and run `node_modules/.bin/tailwind init`, which will generate a fresh configuration file for you, which you are free to change to suit your needs.
28+
29+
### Screenshots
30+
31+
![Dashboard](/screenshots/dashboard.png)
32+
33+
![Login](/screenshots/login.png)
34+
35+
![Register](/screenshots/register.png)
36+
37+
![Reset Password](/screenshots/reset-password-email.png)
38+
39+
![Reset Password](/screenshots/reset-password.png)
40+
41+
![Verify](/screenshots/verify.png)
42+
43+
![Pagination](/screenshots/pagination.png)

screenshots/dashboard.png

21.7 KB
Loading

screenshots/login.png

22 KB
Loading

screenshots/pagination.png

18.3 KB
Loading

screenshots/register.png

22 KB
Loading

screenshots/reset-password-email.png

19.7 KB
Loading

screenshots/reset-password.png

23.1 KB
Loading

screenshots/verify.png

26 KB
Loading

0 commit comments

Comments
 (0)