diff --git a/README.md b/README.md index ebcb239..10d1cb2 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,156 @@ -# TallStackUI +# TallStackUI Starter Kit -

+![TallStackUI Logo](docs/images/tallstackui.svg) -

- Packagist Downloads - Laravel v10.x - PHP 8.1 - Livewire v3.x -

+The **TallStackUI Starter Kit** is an official starter kit for Laravel 12 that provides a solid foundation ready for real-world use, saving time on basic setup of new Laravel projects. -## Welcome +## ๐Ÿš€ Key Features -This is the repository for the official TallStackUI starter kit for Laravel 12. +### Technology Stack +- **Laravel 12** - Modern PHP framework +- **Livewire 3** - Full-stack dynamic components +- **TallStackUI 2** - UI component library +- **TailwindCSS v4** - Utility-first CSS framework -## Documentation +### Included Features -[Discover the starter kit by visiting the official documentation on the TallStackUI website.](https://tallstackui.com/docs/v2/starter-kit) +#### ๐Ÿ“ฑ Responsive and Modern Interface +![Dashboard Preview](docs/images/dashboard-preview.png) + +#### ๐Ÿ” Complete Authentication System +![Login Screen](docs/images/login-screen.png) + +- Login and registration system +- Profile update page +- Authentication based on Laravel Breeze + +#### ๐Ÿ‘ฅ Users CRUD +![Users CRUD](docs/images/users-crud.png) + +Complete CRUD example including: +- User listing +- Creating new users +- Data updates +- Record deletion + +#### ๐ŸŒ™ Dark Theme Support +![Dark Theme](docs/images/dark-theme.png) + +Integrated theme switcher for better user experience. + +#### ๐Ÿ“Š TallStackUI Components +![Components Preview](docs/images/components-preview.png) + +Over 30 ready-to-use components: +- Forms +- UI elements +- Interactions +- Error handling +- And much more + +## ๐Ÿ› ๏ธ Installation + +### Prerequisites +- Laravel Installer installed +- PHP 8.2+ +- Composer + +### Using Laravel Installer (Recommended) +```bash +laravel new project --using=tallstackui/starter-kit +``` + +### Manual Installation +```bash +git clone https://github.com/tallstackui/starter-kit.git project +cd project +rm -rf .git +composer install +npm install +cp .env.example .env +php artisan key:generate +php artisan migrate +``` + +## ๐ŸŽฏ Getting Started + +### Initial Access +![Welcome Page](docs/images/welcome-page.png) + +After installation, access your project. The home page will be the default Laravel page with login and registration buttons at the top. + +### Default Credentials +- **Email:** `admin@tallstackui.com` +- **Password:** `password` + +### Exploring the CRUD +![CRUD Interface](docs/images/crud-interface.png) + +Navigate to `/users` to see the complete CRUD example in action. + +## ๐Ÿ—๏ธ Project Structure + +### Livewire Components Organization +``` +App\Livewire\Users\ +โ”œโ”€โ”€ Index.php # Main listing +โ”œโ”€โ”€ Create.php # User creation +โ”œโ”€โ”€ Update.php # Data updates +โ””โ”€โ”€ Delete.php # Record deletion +``` + +### Included Development Resources + +#### ๐Ÿงช Automated Testing +![Testing](docs/images/testing.png) + +```bash +composer test +``` + +#### ๐Ÿ“Š Code Analysis +```bash +composer analyse # PHPStan +composer format # Pint +composer ci # Complete pipeline +``` + +## ๐ŸŽจ Customization + +### Colors and Theme +![Color Customization] + +The starter kit uses a primary color based on TallStackUI documentation color, easily customizable through the single configuration file. + +### Simplified Configuration +- Single published configuration file +- All unnecessary comments removed +- Clean and organized structure + +## ๐Ÿ“ˆ Benefits + +### โšก Accelerated Development +![Fast Development] + +- Significant time savings on initial setup +- Pre-built and tested components +- Established development patterns + +### ๐Ÿ”ง Production Ready +![Production Ready] + +- SQLite database connection configured +- Comprehensive test coverage included +- Integrated code quality tools + +## ๐Ÿ“š Documentation + +For complete documentation, visit: [TallStackUI Documentation](https://tallstackui.com/docs/v2/starter-kit) + +## ๐Ÿค Contributing + +Want to improve the starter kit? [Send us a pull request!](https://github.com/tallstackui/starter-kit) + +## ๐Ÿ“„ License + +This project is licensed under the MIT License - see the LICENSE file for details. \ No newline at end of file diff --git a/docs/images/components-preview.png b/docs/images/components-preview.png new file mode 100644 index 0000000..a163814 Binary files /dev/null and b/docs/images/components-preview.png differ diff --git a/docs/images/crud-interface.png b/docs/images/crud-interface.png new file mode 100644 index 0000000..7438555 Binary files /dev/null and b/docs/images/crud-interface.png differ diff --git a/docs/images/dark-theme.png b/docs/images/dark-theme.png new file mode 100644 index 0000000..16c36fd Binary files /dev/null and b/docs/images/dark-theme.png differ diff --git a/docs/images/dashboard-preview.png b/docs/images/dashboard-preview.png new file mode 100644 index 0000000..b111435 Binary files /dev/null and b/docs/images/dashboard-preview.png differ diff --git a/docs/images/login-screen.png b/docs/images/login-screen.png new file mode 100644 index 0000000..3de1569 Binary files /dev/null and b/docs/images/login-screen.png differ diff --git a/docs/images/tallstackui.svg b/docs/images/tallstackui.svg new file mode 100644 index 0000000..bbab39c --- /dev/null +++ b/docs/images/tallstackui.svg @@ -0,0 +1,38 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/testing.png b/docs/images/testing.png new file mode 100644 index 0000000..2213eaf Binary files /dev/null and b/docs/images/testing.png differ diff --git a/docs/images/users-crud.png b/docs/images/users-crud.png new file mode 100644 index 0000000..b1ffd2c Binary files /dev/null and b/docs/images/users-crud.png differ diff --git a/docs/images/welcome-page.png b/docs/images/welcome-page.png new file mode 100644 index 0000000..8c0a2a2 Binary files /dev/null and b/docs/images/welcome-page.png differ