Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file modified .devcontainer/install-dependencies.sh
100644 → 100755
Empty file.
125 changes: 125 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
# 🌟 Laravel React Starter Kit: A Symphony of Code

*Where backend whispers to frontend,
In the dance of data and design,
A canvas awaits your masterpiece,
In this digital space divine.*

## 🎭 The Overture

Welcome to the Laravel React Starter Kit, where the robust Laravel framework joins hands with the elegant React library to create a harmonious development experience. This starter kit is not merely a collection of code—it is a carefully orchestrated symphony of technologies, designed to elevate your web application development journey.

## 🌈 A Tapestry of Technologies

*Like stars in the developer's night sky,
These technologies illuminate your path:*

### Backend Constellation ✨
- **Laravel 12+** - The elegant PHP framework that serves as our foundation
- **PHP 8.2+** - The language of server whispers
- **Inertia.js** - The bridge between worlds, connecting Laravel and React
- **Laravel Tinker** - For conversations with your application's soul
- **Ziggy** - Bringing Laravel routes to JavaScript's realm

### Frontend Harmony 🎨
- **React 19** - Where components dance in virtual DOM
- **TypeScript** - Adding types to JavaScript's poetry
- **Tailwind CSS 4** - Styling with utility-first verses
- **Vite 6** - The swift build tool that accelerates development
- **Radix UI** - Accessible UI primitives for your interface sonnets
- **Headless UI** - Unstyled, accessible components waiting for your creative touch

## 🚀 Features That Soar

*Like verses in an epic poem,
These features tell our story:*

- **Single Page Application** - Smooth transitions between pages, like turning the pages of a well-crafted book
- **Server-Side Rendering** - For performance that feels like magic
- **TypeScript Support** - Type safety that guides like a trusted compass
- **Modern UI Components** - Building blocks for your digital cathedral
- **Development Tools** - Craftsman's tools for code perfection:
- ESLint - The guardian of code quality
- Prettier - The poet of code formatting
- Laravel Pint - PHP's style enforcer
- Pest - Testing with elegance

## 🌱 Planting Your Garden

*To begin your journey with this starter kit,
Follow these verses of installation:*

```bash
# Clone the repository
git clone <your-repository-url>

# Navigate to the project directory
cd your-project-name

# Install PHP dependencies
composer install

# Install JavaScript dependencies
npm install

# Copy the environment file
cp .env.example .env

# Generate application key
php artisan key:generate

# Run migrations
php artisan migrate

# Build assets
npm run build
```

## 🎵 The Development Sonata

*To dance with your creation during development:*

```bash
# Start the development server with hot reloading
composer dev

# Or with server-side rendering
composer dev:ssr
```

## 🧪 Testing the Waters

*Verify your creation's integrity:*

```bash
# Run tests
composer test

# Check types
npm run types

# Lint your code
npm run lint

# Format your code
npm run format
```

## 🌟 A Canvas Awaiting Your Brushstrokes

This starter kit is but a beginning—a blank canvas awaiting your creative vision. Build upon this foundation to create web applications that not only function flawlessly but also tell your unique story in the digital landscape.

*May your code be elegant,
Your interfaces intuitive,
And your applications,
A testament to digital craftsmanship.*

## 📜 License

The Laravel React Starter Kit is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

---

*Created with passion and precision,
For developers who see code as art,
And functionality as poetry.*