docs: professional SEO-optimized README with badges

Author: morpheusadam

README.md

@@ -1,169 +1,174 @@
-![Installation Complete](public/Documentation/4.png)
-# Laravel Shop Generator - Laravel Ecommerce CMS
-
-Laravel Shop Generator is a powerful and feature-rich Ecommerce CMS built with Laravel. It provides a comprehensive solution for creating and managing an online store with ease.
-
-## Features
+<div align="center">
 
-- **Multiple Language Support**
-- **Multiple Currency Support**
-- **Product Attributes and Options**
-- **Order Management**
-- **Brands, Tags, and Reviews**
-- **Flash Sales and Coupons**
-- **Wishlist and Compare**
-- **Guest Checkout**
-- **Invoice Generation**
-- **Advanced Search and Filtering**
-- **SEO Optimized**
-- **Beautiful & Powerful Admin Panel**
-- **Scheduled Currency Rate Updating**
-- **Custom Static Pages**
-- **Advanced System Reports**
-- **Maintenance Mode**
-- **And More...**
+# 🏬 Laravel Shop Generator
 
-## Requirements
+### A powerful, feature-rich **Laravel eCommerce CMS** for building and managing an online store — multi-language, multi-currency, modular architecture, PWA-ready, with a beautiful and powerful admin panel.
 
-- **PHP:** 7.4+ (Recommended: 8.1 or higher)
-- **MySQL:** 5.6+ or MariaDB 10.0+
-- **PHP Extensions:**
-  - Intl
-  - OpenSSL
-  - PDO
-  - Mbstring
-  - Tokenizer
-  - XML
-  - Ctype
-  - JSON
+<p>
+  <img src="https://img.shields.io/github/license/morpheusadam/laravel-shop-generator?style=for-the-badge&color=4c1" alt="License" />
+  <img src="https://img.shields.io/github/stars/morpheusadam/laravel-shop-generator?style=for-the-badge&color=ffca28" alt="Stars" />
+  <img src="https://img.shields.io/github/forks/morpheusadam/laravel-shop-generator?style=for-the-badge&color=42a5f5" alt="Forks" />
+  <img src="https://img.shields.io/github/last-commit/morpheusadam/laravel-shop-generator?style=for-the-badge&color=8e44ad" alt="Last commit" />
+  <img src="https://img.shields.io/github/repo-size/morpheusadam/laravel-shop-generator?style=for-the-badge&color=e67e22" alt="Repo size" />
+</p>
 
-## Installation
+<p>
+  <img src="https://img.shields.io/badge/Laravel-10-FF2D20?style=for-the-badge&logo=laravel&logoColor=white" alt="Laravel" />
+  <img src="https://img.shields.io/badge/PHP-8.1%2B-777BB4?style=for-the-badge&logo=php&logoColor=white" alt="PHP" />
+  <img src="https://img.shields.io/badge/MySQL-Database-4479A1?style=for-the-badge&logo=mysql&logoColor=white" alt="MySQL" />
+  <img src="https://img.shields.io/badge/Vue.js-2-4FC08D?style=for-the-badge&logo=vuedotjs&logoColor=white" alt="Vue" />
+  <img src="https://img.shields.io/badge/Bootstrap-UI-7952B3?style=for-the-badge&logo=bootstrap&logoColor=white" alt="Bootstrap" />
+  <img src="https://img.shields.io/badge/Vite-Build-646CFF?style=for-the-badge&logo=vite&logoColor=white" alt="Vite" />
+  <img src="https://img.shields.io/badge/PWA-Ready-5A0FC8?style=for-the-badge&logo=pwa&logoColor=white" alt="PWA" />
+</p>
 
-### Step 1: Extract and Upload
+</div>
 
-1. Unzip the downloaded archive package.
-2. Rename the `Laravel Shop Generator` directory to your desired directory name.
-3. Upload the directory to your web server through FTP or Control Panel.
+---
 
-### Step 2: Creating Database
+## 📖 Overview
 
-1. Create a database for Laravel Shop Generator through your server control panel.
-2. If your server has phpMyAdmin, you can also create a database using phpMyAdmin.
+**Laravel Shop Generator** is a complete, feature-rich **eCommerce CMS** built on **Laravel 10**. It provides everything you need to create, launch, and manage a modern online store — a polished customer storefront, a powerful admin panel, and a **modular architecture** (powered by `nwidart/laravel-modules`) that keeps the codebase clean and extensible.
 
-### Step 3: Install Dependencies
+Out of the box it supports **multiple languages and currencies**, rich product attributes and options, order management, coupons and flash sales, wishlist and compare, guest checkout, invoice generation, and advanced search and filtering. A guided web installer, system requirement checks, license handling, and an update system make deployment straightforward, while built-in **PWA** support, scheduled currency-rate updates, and advanced reports round out a store-ready toolkit.
 
-1. Navigate to the project directory:
-    ```bash
-    cd /path/to/your/laravel-shop-generator
-    ```
-2. Install Composer dependencies:
-    ```bash
-    composer install
-    ```
-3. Install NPM dependencies:
-    ```bash
-    npm install
-    ```
+It's ideal for **store owners, agencies, and developers** who want a customizable Laravel-based shop platform with a modular, scaffold-friendly foundation.
 
-### Step 4: Environment Configuration
+> 🔎 **Keywords:** laravel ecommerce cms, online store, laravel shop, multi-language store, multi-currency, modular laravel, nwidart modules, pwa ecommerce, admin panel, flash sales, coupons, guest checkout.
 
-1. Copy the `.env.example` file to `.env`:
-    ```bash
-    cp .env.example .env
-    ```
-2. Open the `.env` file and configure your environment variables, including database connection details.
+---
 
-### Step 5: Generate Application Key
+## ✨ Features
+
+- 🌐 **Multiple language support**
+- 💱 **Multiple currency support** with scheduled rate updates
+- 🧩 **Product attributes & options**
+- 📦 **Order management**
+- 🏷️ **Brands, tags & reviews**
+- ⚡ **Flash sales & coupons**
+- ❤️ **Wishlist & compare**
+- 🛒 **Guest checkout**
+- 🧾 **Invoice generation**
+- 🔍 **Advanced search & filtering**
+- 📈 **SEO optimized**
+- 🖥️ **Beautiful & powerful admin panel**
+- 📄 **Custom static pages**
+- 📊 **Advanced system reports**
+- 🛠️ **Maintenance mode**
+- 🧱 **Module & entity scaffolding** (Artisan generators)
+- 📲 **PWA support** (installable web app)
+- 🧰 **Guided web installer** with requirement checks
+- ➕ **And more...**
 
-1. Generate the application key:
-    ```bash
-    php artisan key:generate
-    ```
+---
 
-### Step 6: Run Migrations and Seed Database
+## 🛠️ Tech Stack
 
-1. Run the database migrations and seed the database:
-    ```bash
-    php artisan migrate --seed
-    ```
+<p align="center">
+  <img src="https://skillicons.dev/icons?i=laravel,php,mysql,vue,bootstrap,vite,sass,redis" alt="Tech stack" />
+</p>
 
-### Step 7: Build Frontend Assets
+| Layer | Technologies |
+| --- | --- |
+| Backend | Laravel 10, PHP 8.1+, nwidart/laravel-modules, Doctrine DBAL |
+| Frontend | Blade, Vue 2, Bootstrap, Alpine.js, jQuery, Sass, Vite |
+| Caching | Predis adapter, alternative-laravel-cache |
+| PWA & i18n | silviolleite/laravelpwa, Symfony Intl |
+| Tooling | Wikimedia Composer Merge Plugin, dotenv-editor, PostCSS RTLCSS |
 
-1. Build the frontend assets:
-    ```bash
-    npm run dev
-    ```
+---
 
-### Step 8: Run Installation Wizard
+## 🚀 Getting Started
 
-1. Go to your website address.
-2. Follow the installation wizard.
+### Requirements
 
-**Note:** You should configure your web server's document/web root to be the `public` directory.
+- **PHP 8.1+** with Composer (`ext-gd` enabled)
+- **MySQL 5.6+** or **MariaDB 10.0+**
+- **Node.js & npm**
+- Required PHP extensions: Intl, OpenSSL, PDO, Mbstring, Tokenizer, XML, Ctype, JSON
 
-### Pre-Installation
+### Installation
 
-The pre-installation page checks if your server meets the requirements and has the correct directory permissions to set up Laravel Shop Generator. Ensure that directories within the `storage` and the `bootstrap/cache` directories are writable by your web server.
+```bash
+# 1. Get the code
+git clone https://github.com/morpheusadam/laravel-shop-generator.git
+cd laravel-shop-generator
 
-### Configuration
+# 2. Install dependencies
+composer install
+npm install
 
-Fill in the database connection details, administration details, and store details, then click the `Install` button to install Laravel Shop Generator.
+# 3. Configure environment
+cp .env.example .env
+php artisan key:generate
 
-### Complete
+# 4. Set your database credentials in .env, then migrate & seed
+php artisan migrate --seed
 
-After successfully installing Laravel Shop Generator, you will see a success message. You now have the option to browse your online store or log into the administration panel.
+# 5. Build frontend assets
+npm run build      # or: npm run dev
+```
 
-## Admin Login
+Then serve the app and complete setup via the guided web installer:
 
-- **URL:** [https://your-domain.com/admin](https://your-domain.com/admin)
-- **Email:** `admin@email.com`
-- **Password:** `123456`
+```bash
+php artisan serve
+```
 
-## User Login
+> 💡 You can also create the database through your hosting control panel / phpMyAdmin and run the **web installer** to finish configuration.
 
-- **URL:** [https://your-domain.com/login](https://your-domain.com/login)
-- **Email:** `admin@email.com`
-- **Password:** `123456`
+---
 
-## Changelog
+## ⚙️ Module Scaffolding
 
-### Version 4.3.1 (5 Jul 2024)
-- Fix file manager issue
+Laravel Shop Generator uses a modular structure. New modules and entities can be scaffolded with the built-in Artisan commands:
 
-### Version 4.3.0 (3 Jul 2024)
-- Add new sidebar cart design
-- Add new newsletter popup design
-- Add locale switcher in auth pages
-- Add ability to change storefront font with 17 fonts preset
-- Fix product gallery lightbox duplicate images
-- Fix missing translations
-- Fix responsive issues
-- Improve accessibility
-- Improve storefront theme design
+```bash
+php artisan scaffold:module    # scaffold a new module
+php artisan scaffold:entity    # scaffold a new entity
+```
 
-... (Include other versions as needed)
+---
 
-## License
+## 🗂️ Project Structure
+
+```text
+laravel-shop-generator/
+├── app/
+│   ├── Http/Controllers/   # Install & License controllers
+│   ├── Install/            # Web installer (requirements, DB, store, admin)
+│   ├── Scaffold/Module/    # Module & entity generators + stubs
+│   └── Updater.php         # Update system
+├── config/                 # app, database, sentinel, modules, ...
+├── Modules/                # Feature modules (nwidart/laravel-modules)
+├── resources/              # Blade views & frontend assets
+└── routes/                 # Application routes
+```
 
-This project is licensed under the terms of the [Envato Regular License](https://codecanyon.net/licenses/standard).
+---
 
-## Support
+## 🤝 Contributing
 
-For support, please contact [EnvaySoft](https://codecanyon.net/user/envaysoft).
+Contributions are welcome! Open an [issue](https://github.com/morpheusadam/laravel-shop-generator/issues) or submit a pull request with new features, fixes, or improvements.
 
----
+## 📜 License
+
+See the repository's license terms (add a `LICENSE` file if distributing). Built on the open-source **Laravel** framework (MIT).
 
-© All Rights Reserved EnvaySoft
+---
 
-## Screenshots
-## 📞 Contact Me
 <div align="center">
-    <a href="https://www.linkedin.com/in/hesam-ahmadpour" style="color: red; font-size: 20px; text-decoration: none;">LinkedIn</a> |
-    <a href="https://t.me/morpheusadam" style="color: red; font-size: 20px; text-decoration: none;">Telegram</a>
-</div>
 
+### 👤 Author — Morpheus Adam
 
-![Installation Step 1](public/Documentation/1.png)
-![Installation Step 2](public/Documentation/2.png)
-![Installation Step 3](public/Documentation/3.png)
-![Installation Complete](public/Documentation/4.png)
+Web developer & cheerful hacker · PHP · Laravel · Go
+
+<p>
+  <a href="https://github.com/morpheusadam"><img src="https://img.shields.io/badge/GitHub-morpheusadam-181717?style=for-the-badge&logo=github&logoColor=white" alt="GitHub" /></a>
+  <a href="https://sam.zeonic.me"><img src="https://img.shields.io/badge/Website-sam.zeonic.me-4c1?style=for-the-badge&logo=googlechrome&logoColor=white" alt="Website" /></a>
+  <a href="mailto:morpheusadam95@gmail.com"><img src="https://img.shields.io/badge/Email-Contact-D14836?style=for-the-badge&logo=gmail&logoColor=white" alt="Email" /></a>
+</p>
+
+⭐ **If Laravel Shop Generator helped you launch your store, please give it a star!** ⭐
+
+</div>