An open API service indexing awesome lists of open source software.

https://github.com/sadegh19b/larafilastarter

A Laravel starter kit with Filament for panels, persian language, persian validation, vazirmatn font, and essential features for rapid application development.
https://github.com/sadegh19b/larafilastarter

filament filamentphp laravel laravel-filament laravel-starter-kit starter-kit

Last synced: about 1 month ago
JSON representation

A Laravel starter kit with Filament for panels, persian language, persian validation, vazirmatn font, and essential features for rapid application development.

Awesome Lists containing this project

README

        

# Larafila Starter Kit

A Laravel starter kit with Filament for panels, persian language, persian validation, vazirmatn font, and essential features for rapid application development.

Inspired from [vest-kits (laravel)](https://github.com/vest-kits/laravel) by [Nuno Maduro](https://github.com/nunomaduro)

## ๐Ÿš€ Features

- **Laravel 12.x**
- **Filament 3.x**
- **Livewire 3.x**
- **Tailwind CSS 4.x**
- **Pest PHP**
- **PHPStan**
- **Rector**
- **Laravel Pint**
- **Laravel Persian Language**
- **Laravel Persian Validation**
- **Vazirmatn Font**

## ๐Ÿ“ฆ Requirements

- PHP 8.2 or higher
- Composer
- Node.js & NPM
- MySQL/PostgreSQL
- Web Server (Apache/Nginx)

## ๐Ÿ›  Installation

1. Clone the repository:
```bash
git clone https://github.com/sadegh19b/LarafilaStarter.git
```

2. Install PHP dependencies:
```bash
composer install
```

3. Install NPM dependencies:
```bash
npm install
```

4. Create environment file:
```bash
cp .env.example .env
```

5. Generate application key:
```bash
php artisan key:generate
```

6. Run migrations:
```bash
php artisan migrate
```

7. Start the development server:
```bash
php artisan serve
```

## ๐Ÿ“ Notes

- For better performance, suggest to use the below commands to cache icons and components:
```bash
php artisan icons:cache
php artisan filament:cache-components
```

- You can use the google fonts for `Vazirmatn` font:
```bash

```
Or use the font from the `public/css/fonts/vazirmatn.css` file, for filament or views.

## ๐Ÿ— Project Structure

```
app/
โ”œโ”€โ”€ Actions/ # Business logic actions
โ”œโ”€โ”€ Enums/ # Enums
โ”œโ”€โ”€ Fields/ # Model field constants
โ”œโ”€โ”€ Filament/ # Filament admin panel resources
โ”œโ”€โ”€ Http/
โ”‚ โ”œโ”€โ”€ Controllers/
โ”œโ”€โ”€ Icons/ # Blade ui kit icons (heroicons)
โ”œโ”€โ”€ Models/ # Eloquent models
โ”œโ”€โ”€ Services/ # Service classes
โ””โ”€โ”€ Support/ # Support classes
```

## ๐Ÿงช Testing

Run tests using Pest PHP:
```bash
composer test
```

Run code style checks:
```bash
composer lint
```

Run refactoring with Rector:
```bash
composer refactor
```

## ๐Ÿ“š Documentation

- [Laravel Documentation](https://laravel.com/docs)
- [Laravel Pint Documentation](https://laravel.com/docs/12.x/pint)
- [Filament Documentation](https://filamentphp.com/docs)
- [Livewire Documentation](https://livewire.laravel.com/docs)
- [Tailwind CSS Documentation](https://tailwindcss.com/docs)
- [Pest PHP Documentation](https://pestphp.com/docs)
- [Rector Documentation](https://getrector.com/documentation)
- [Rector Laravel Documentation](https://github.com/driftingly/rector-laravel)
- [PHPStan Documentation](https://phpstan.org)
- [Laravel Persian Validation](https://github.com/sadegh19b/laravel-persian-validation)
- [Vazirmatn Font](https://github.com/rastikerdar/vazirmatn)
- [Heroicons](https://heroicons.com/)

## ๐Ÿ“„ License

This project is licensed under the MIT License.