README

The official starter kit to jumpstart your next Laravel application, powered by the SheafUI component platform.

Installation

to start using new laravel app using this skeleton

 laravel new example-name --using=sheaf/starter-kit

Zero Dependency, Full Control

This starter kit requires no external dependencies and gives you 100% ownership of your code. While powered by SheafUI resources, every line of code is yours to modify and customize as needed.

✨ Features

• SheafUI Integration - Optional setup for complete development with the SheafUI platform
• Complete Auth System - Login, register, logout, email verification, password reset/forgot, password confirmation - all with comprehensive tests
• Clean Dark Theme - Seamless light/dark mode switching
• Flexible Toast System - User-friendly notifications out of the box
• Basic Account Management - Update account information (name, email) and change password

Note

Dashboard and settings pages are temporary implementations. They will be refactored once the sidebar, header, and navlist components are built and integrated.

Note

also avatar uplaod will be added once the file upload components is built and integrated

Tech Stack

• Laravel 12 - Latest Laravel framework
• Livewire 3 - Modern reactive components
• Heroicons - Beautiful SVG icons via wireui/heroicons
• Sheaf CLI - SheafUI command-line tools
• Tailwind 4 - Modern utility-first CSS framework
• Pest 4 - Elegant testing framework

Included Components

Your starter kit comes pre-loaded with essential UI components:

• Icon - SVG icon system
• Button - Customizable button variants
• Avatar - User profile images with fallbacks
• Dropdown - Accessible dropdown menus
• Input - Form input controls
• Separator - Visual content dividers
• Field - Form field wrapper
• Fieldset - Grouped form controls
• Label - Accessible form labels
• Link - Styled navigation links
• Theme Switcher - Light/dark mode toggle
• Toast - Notification system
• Error - Error handling displays
• Text - Unified Text styling
• Heading - Heading components
• Card - blocks of UI

Perfect For

• New Laravel projects requiring solid UI foundation.
• Developers who want proven components without vendor lock-in.
• Teams needing authentication and theming out of the box.

Ready to build something amazing? Get started with SheafUI today! 🎉

Author

MOHAMED CHARRAFI

Others

the borders pattern used at home, auth pages was designed by AYOUB EL HAJJI

License

Sheaf UI is open source software licensed under the MIT License.