docs: Update README to enhance installation instructions and add details on MinIO and translations

Author: SamuelBisberg

README.md

@@ -2,24 +2,173 @@
 
 ## Introduction
 
-Our React starter kit provides a robust, modern starting point for building Laravel applications with a React frontend using [Inertia](https://inertiajs.com).
+This is a fork of the [Laravel + React Starter Kit](https://github.com/laravel/react-starter-kit) with my additional features and improvements. Such as:
 
-Inertia allows you to build modern, single-page React applications using classic server-side routing and controllers. This lets you enjoy the frontend power of React combined with the incredible backend productivity of Laravel and lightning-fast Vite compilation.
+- **Laravel Debugbar**: Integrated for debugging and profiling.
+- **Laravel Data & Typescript**: Utilizes [spatie/laravel-data](https://spatie.be/docs/laravel-data) for data handling and [spatie/typescript-transformer](https://spatie.be/docs/typescript-transformer/v2/laravel) for TypeScript support.
+- **Laravel Translatable & Translations**: Fully translated into Hebrew & supports translatable columns with [spatie/laravel-translatable](https://spatie.be/docs/laravel-translatable)
+- **MinIO & Media Library**: For file uploads and media management.
+- **Sail Included**: Docker support with Laravel Sail for easy local development.
 
-This React starter kit utilizes React 19, TypeScript, Tailwind, and the [shadcn/ui](https://ui.shadcn.com) and [radix-ui](https://www.radix-ui.com) component libraries.
+And much more!
 
-## Official Documentation
+## Requirements
 
-Documentation for all Laravel starter kits can be found on the [Laravel website](https://laravel.com/docs/starter-kits).
+From a Linux distro of your choice, you will need:
 
-## Contributing
+- [Docker](https://docs.docker.com/get-docker/) - Containerization platform.
+- [Docker Compose](https://docs.docker.com/compose/install/) - Tool for defining and running multi-container Docker applications.
+- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) - Version control system.
+- [Bun](https://bun.sh/docs/install) - JavaScript runtime.
+- [Node.js](https://nodejs.org/en/download/) - JavaScript runtime environment.
+- [PHP 8.4 or higher and Composer](https://laravel.com/docs/#installing-php)
 
-Thank you for considering contributing to our starter kit! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+## Installation
 
-## Code of Conduct
+1. Fork the repository and clone it to your local machine:
 
-In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
+   This will help you get changes merged back into the main repository.
 
-## License
+   ```bash
+   git clone <your-fork-url>
+   cd <your-repo-name>
+   ```
 
-The Laravel + React starter kit is open-sourced software licensed under the MIT license.
+2. Run app with Sail:
+
+   ```bash
+   # Don't forget to add the alias to your shell config file (e.g., .bashrc, .zshrc)
+   # alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'
+   sail up -d
+   ```
+
+3. Install dependencies:
+
+   ```bash
+   sail composer install
+   sail npm install # or `sail bun install`
+   ```
+
+4. Copy the `.env.example` file to `.env`:
+
+   ```bash
+   cp .env.example .env
+   ```
+
+5. Generate application key:
+
+   ```bash
+    sail artisan key:generate
+    ```
+
+6. Run migrations and seed the database:
+  
+    ```bash
+    sail artisan migrate --seed
+    ```
+
+7. Run the development server:
+
+   ```bash
+   sail composer run dev
+   ```
+
+## Debugger & Playground
+
+The application includes the [Laravel Debugbar](https://laraveldebugbar.com/) for debugging and profiling.
+
+You can use the `Playground` at [http://localhost/playground](http://localhost/playground) and play with:
+
+- [The Controller](/app/Http/Controllers/PlaygroundController.php) - You can modify the controller to test different scenarios.
+- [The View](/resources/js/pages/playground/index.tsx) - You can modify the view to test different scenarios.
+
+## File Uploads w/ MinIO & Media Library
+
+MinIO is used for file uploads. You can access the MinIO dashboard at [localhost:9000](http://localhost:9000) with the credentials:
+
+- **Access Key**: sail
+- **Secret Key**: password
+
+In the laravel app you can use the package for managing files: [spatie/laravel-medialibrary](https://spatie.be/docs/laravel-medialibrary)
+
+### Temporary Files
+
+<!-- TODO: Implement -->
+...
+
+Note: `laravel-medialibrary` uses optimization packages. Install them with:
+
+```bash
+sudo apt install jpegoptim optipng pngquant gifsicle libavif-bin
+npm install -g svgo # or `sudo snap install svgo`
+```
+
+## Translations & Translatable Columns
+
+The application is fully translated into Hebrew. The translation files are located in the `lang/he` directory and `lang/he.json` for JSON translations.
+
+Use the package [bottelet/translation-checker](https://bottelet.github.io/translation-checker) to check for missing translations, automatically generate translation with `Google Translate` using the command:
+
+```bash
+sail translations:check en --sort --translate-missing
+#                       └─target: `en`, `he` or any other language
+```
+
+In addition, the `spatie/laravel-translatable` package is used to handle translatable columns in the database. You can define translatable attributes in your models like this:
+
+```php
+use Spatie\Translatable\HasTranslations;  
+
+class YourModel extends Model
+{
+    use HasTranslations;
+
+    public $translatable = ['name', 'description'];
+}
+```
+
+## Laravel Data & Typescript
+
+The application uses [spatie/laravel-data](https://spatie.be/docs/laravel-data) for data handling and [spatie/typescript-transformer](https://spatie.be/docs/typescript-transformer/v2/laravel) for TypeScript support.
+
+Use `Laravel Data` to create DTOs with single source of truth for validation rules, type safety, and serialization. This allows you to define your data structures in a clean and maintainable way.
+
+Create a `Data` class with:
+
+```bash
+sail artisan make:data <DataClassName>
+```
+
+Annotate your data classes with `TypeScript` to generate TypeScript types:
+
+```php
+use Spatie\LaravelData\Data;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
+
+#[TypeScript]
+class UserData extends Data
+{
+    public function __construct(
+        public string $name,
+        public string $email,
+        // ...
+    ) {}
+}
+
+```
+
+Then, generate the TypeScript types with:
+
+```bash
+sail artisan typescript:transform
+```
+
+This will generate TypeScript types in the `resources/js/types/generated.d.ts` file so you can use them in your the frontend.
+
+You have Laravels's additional types such as `Paginator`, `EnumTtait` with usefull methods like `toCollection()` in `resources/js/types/index.d.ts`.
+
+## Validation
+
+In addition to the default validation rules, We have added the following custom validation rule:
+
+- **Phone**: Validates that the input is a valid phone number using the package [propaganistas/laravel-phone](https://github.com/propaganistas/laravel-phone).