fix: updated documentation and added release workflow

Author: iamspydey

.github/docs-stubs/DOCUMENTATION.stub.md

@@ -0,0 +1,86 @@
+# Getting Started
+
+## 📚 Table of Contents
+
+1. [Requirements](#1-requirements)
+2. [Installation](#2-installation)
+    - [Use it as Template](#use-it-as-template)
+    - [Clone It](#clone-it)
+    - [Why Using Git?](#using-git)
+        - [How this works?](#how-this-works)
+3. [Features](#3-built-in-features)
+    - [Auth System](#auth-system)
+    - [Global Configurations](#global-configurations)
+    - [Email Templates](#email-templates)
+
+## 1. Requirements
+
+Make sure you have the following installed:
+
+- PHP 8.4+
+- Composer
+- Node.js & npm (or yarn/pnpm)
+
+## 2. Installation
+
+### Use it as Template
+
+You can just go to github page of this repository from [here](https://github.com/devsbuddy/laravel-react-starter-kit) and select `Use this template` button to create your own repository using this starter-kit.
+
+### Clone it
+
+Or you can clone this starter-kit directly by:
+
+```bash
+git clone https://github.com/devsbuddy/laravel-react-starter-kit.git your-awesome-app
+```
+
+### Using Git?
+
+**_Why using git clone instead of composer install?_**
+
+This starter kit will only be available as a GitHub repository or a repository template. It will not be released on Packagist, which means you won’t be able to install or create a project using Composer.
+
+The main goal of this starter kit is to be an independent, easy-to-update base that can quickly receive new features or bug fixes in the future.
+
+A common issue with most starter kits is that once you create a project from them, your project can’t easily receive future updates made to the original kit. To solve this, this starter kit works differently — instead of releasing it as a typical package, you can create your project using this kit and then add it as a Git remote in your own repository. This way, you’ll be able to pull future updates directly.
+
+#### How this works?
+
+Git and GitHub already provide a feature that allows you to use multiple remote URLs for a single repository.
+Your project will have its own remote URL (usually named `origin`) to track your work, and you can also add this starter kit’s remote URL — for example, as `starter-kit` or `updates` (you can choose any name you like).
+
+In the future, if this starter kit receives new updates, you can simply fetch the latest changes from that remote and merge them into your project. This way, your project will always stay up to date with the starter kit.
+
+> Keep in mind that if you modify any core functionality or features from the starter kit, you might face some merge conflicts when applying future updates. Otherwise, fetching the latest updates will be smooth and straightforward.
+
+**Tip**: Checkout [Updating Guide](UPDATING.md) to know how you can receive future updates.
+
+## 3. Built in features
+
+This starter kit comes with several built-in features that are commonly used across projects. It helps you avoid reinventing the wheel every time by providing a solid foundation with essential features that most projects need.
+
+### Auth System
+
+Every application needs some form of authentication, and this starter kit includes one as well. Like Laravel’s official starter kits, it now supports **`2FA authentication`** as this is a fork of it. This isn’t a new feature in this starter kit — I’ve simply adjusted and tweaked certain parts to match the coding style and conventions of this starter kit otherwise it is from the laravel official starter kit.
+
+### Global Configurations
+
+Whenever you build an application, you often need a central place to store commonly used data that can be easily managed and updated without extra work.
+
+To address this, the starter kit includes a global app configuration feature. It stores information such as `Application Logo`, `Favicon`, `Application Name`, `Email Configurations`, and more in a dedicated database table. You can manage these settings easily from the dashboard and use them throughout the application without worrying about future changes.
+
+### Email Templates
+
+Why use email templates instead of creating a Mailable class every time?
+
+This feature uses dynamic Mailable classes to send emails, so you don’t need to create a new Mailable class, fill in the details, and design the email UI each time.
+
+The starter kit provides two types of dynamic Mailable classes:
+
+1. A regular synchronous class that sends emails immediately during the HTTP request.
+2. A queueable class that sends emails in the background using Laravel’s queue system.
+
+Yes, you read that right — this starter kit supports both synchronous and queueable emails to cover all your email needs. You can configure this setting in the Global App Configuration to choose whether emails should be queued or sent immediately. Once set, emails will work automatically according to your preference.
+
+#### More features are coming soon...

.github/docs-stubs/README.stub.md

@@ -0,0 +1,137 @@
+# Laravel + React Starter Kit - ${LATEST_VERSION}
+
+[Shoaib Khan](https://github.com/iamspydey) from [Devs Buddy](https://devsbuddy.com) presenting you a highly opinionated Laravel Starter Kit with Inertia and React. It helps you get up and running quickly with clean, consistent, and fully type-safe code.
+
+## 🧩 Introduction
+
+This starter kit is a fork of [laravel's official react starter kit](https://github.com/laravel/react-starter-kit).
+
+It has been modified to be fully strict, with 100% type safety, and follows an action-oriented pattern.
+
+A few more helpful default features have been added, and the built-in authentication system has been updated to follow these strict rules.
+This ensures consistent code quality across your entire project.
+
+---
+
+## 🌟 Inspirations
+
+- [nunomaduro/laravel-starter-kit-inertia-react](https://github.com/nunomaduro/laravel-starter-kit-inertia-react)
+- [nunomaduro/laravel-starter-kit](https://github.com/nunomaduro/laravel-starter-kit)
+
+These projects were the main inspiration for creating this starter kit. I’ve added additional features that are essential for most modern applications.
+
+## 🚀 Highlights
+
+1. **Fully Strict Types**: It follows 100% of type coverage for all the classes, methods and logic.
+2. **Action Oriented Pattern**: It uses dedicated Action classes for handling business logic and mutations. This keeps your controllers clean and makes actions reusable across your project.
+3. **Cruddy by Design**: It embraces the Cruddy by Design pattern to stay aligned with Laravel’s core concepts, making everything easy to understand and extend.
+
+---
+
+## ⚙️ Default features
+
+1. **Authentication**: Based on Laravel’s built-in authentication, with a few tweaks to fit this project’s structure and standards.
+2. **Global Configs**: Most apps need some kind of global configuration that can be managed from one place and applied across the app. Includes settings like:
+    - App Logo
+    - App Favicon
+    - Basic Mail Config (excluding mail server credentials)
+3. **Mail Templates**: Includes a dynamic mail template system with a flexible Mailable class.
+   You can create templates with fields like Subject and Content, then send emails by simply calling helper methods with the template code — it just works.
+4. **Queuable Mail**: The mailing system combines the global config and mail template features.
+   If mail queueing is enabled in the config, emails will automatically be pushed to the queue for asynchronous delivery.
+5. **Events**: From the beggining this starter kit includes some events that are being fired on each action that may some other action in future, for this I follow to create Event for each action taken in the app, this way in future you just add a listener to listen these events and act upon them.
+    - Why custom events instead of model observers?
+
+        I prefer explicit event handling over “magic” behavior. With custom events, you can keep logic clean and encapsulated inside dedicated listener classes.
+
+6. **Custom Helpers**: Instead of a typical `helpers.php` file, this kit organizes helpers as **Traits**, **Services**, **Support** classes, and **Facades**.
+    - A small `helpers.php` file is still included for global functions where class imports aren’t possible.
+
+---
+
+## 🧰 Getting Started
+
+### 1. Requirements
+
+Make sure you have the following installed:
+
+- PHP 8.4+
+- Composer
+- Node.js & npm (or yarn/pnpm)
+
+### 2. Installation
+
+Clone the repository and install dependencies:
+
+```bash
+git clone https://github.com/devsbuddy/laravel-react-starter-kit.git your-awesome-app
+```
+
+### Setup
+
+Navigate to newly created prject directory and run setup commands
+
+```bash
+cd your-awesome-app # Navigate to the project directory
+
+composer setup # Install all deps and setup project
+```
+
+### Configure
+
+By default this starter kit uses sqlite database and if you want to use other database driver you can configure that in your `.env` file:
+
+```bash
+# Example PostgreSQL Config
+
+DB_CONNECTION=pgsql
+DB_HOST=127.0.0.1
+DB_PORT=5432
+DB_DATABASE=your_awesome_app
+DB_USERNAME=postgres
+DB_PASSWORD=
+```
+
+After configuring new database you can run migration and seeders:
+
+```bash
+php artisan migrate --seed
+
+# OR
+
+php artisan migrate:fresh --seed
+```
+
+### Start development server
+
+Now as the app is all setup correctly you can start working on it:
+
+```bash
+# Start development server
+composer dev
+```
+
+### Check on browser
+
+After running your development server you can visit to [http://localhost:8000](http://localhost:8000) or [http://127.0.0.1:8000](http://127.0.0.1:8000) on your favorite browser to see the app in action.
+
+### Documentatin
+
+You can find more refined and detailed [Documentation](DOCUMENTATION.md) here.
+
+### 🤝 Contributing
+
+Contributions are welcome!
+If you’d like to improve this starter kit, feel free to:
+
+1. Fork the repository
+2. Create a new feature branch (`git checkout -b feature/your-feature`)
+3. Commit your changes (`git commit -m 'Added some feature'`)
+4. Push to the branch (`git push origin feature/your-feature`)
+5. Open a Pull Request
+
+Please make sure your code follows the existing structure and style conventions also all tests are passing.
+
+### 📄 License
+
+This project is open-source and available under the MIT License.