update readme.md

README.md

@@ -1,79 +1,126 @@
-<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
+# eCommerce Single Admin WebApp
 
-<p align="center">
-<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
-<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
-</p>
+## Overview
 
-## About Laravel
+The **eCommerce Single Admin WebApp** is a powerful platform tailored for small businesses, allowing administrators to manage products, categories, and orders with ease. This application simplifies the complexities of online store management, providing essential features for product handling and order processing.
 
-Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
+## Features
 
-- [Simple, fast routing engine](https://laravel.com/docs/routing).
-- [Powerful dependency injection container](https://laravel.com/docs/container).
-- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
-- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
-- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
-- [Robust background job processing](https://laravel.com/docs/queues).
-- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
+- **User Authentication**: Secure login and logout functionalities.
+- **Product Management**: Add, delete, edit, and update products effortlessly.
+- **Category Management**: Organize and manage product categories and subcategories.
+- **Sales Overview**: View total sales figures and current inventory levels.
+- **Stock Alerts**: Notifications for products with low stock (below 5).
+- **Order Management**: Users can place orders, while admins can complete or cancel them.
 
-Laravel is accessible, powerful, and provides tools required for large, robust applications.
+## Technology Stack
 
-## Learning Laravel
+- **Frontend**: HTML, CSS, JavaScript, jQuery DataTable, Bootstrap, Toastr
+- **Backend**: Laravel 11
+- **Authentication**: Breez
+- **Roles and Permissions**: Laratrust
 
-Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
+## Usage / Use
 
-You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
+Access the application in your browser at `http://localhost:8000` (or the URL provided by the `php artisan serve` command).
 
-If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
+1. **User Login**: Users can log in using their credentials.
+2. **User Logout**: Users can log out to secure their accounts.
+3. **Order Products**: Users can browse products and place orders.
+4. **Admin Actions**: Admins can manage products, categories, view sales, and process or cancel orders.
+## Installation
 
-## Laravel Sponsors
+### Prerequisites
 
-We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
+- PHP 8.2.12
+- Composer
+- Node.js and npm
 
-### Premium Partners
+### Setup Steps
 
-- **[Vehikl](https://vehikl.com/)**
-- **[Tighten Co.](https://tighten.co)**
-- **[WebReinvent](https://webreinvent.com/)**
-- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
-- **[64 Robots](https://64robots.com)**
-- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
-- **[Cyber-Duck](https://cyber-duck.co.uk)**
-- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
-- **[Jump24](https://jump24.co.uk)**
-- **[Redberry](https://redberry.international/laravel/)**
-- **[Active Logic](https://activelogic.com)**
-- **[byte5](https://byte5.de)**
-- **[OP.GG](https://op.gg)**
+1. **Clone the repository**:
 
-## Contributing
+   ```bash
+   git clone [repository-url]
+   cd ecommerce-single-admin-webapp
+   ```
 
-Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
+2. **Install Composer dependencies**:
 
-## Code of Conduct
+   ```bash
+   composer install
+   ```
 
-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).
+3. **Generate application key**:
 
-## Security Vulnerabilities
+   ```bash
+   php artisan key:generate
+   ```
 
-If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
+4. **Cache the configuration**:
 
-## License
+   ```bash
+   php artisan config:cache
+   ```
+
+5. **Install npm packages**:
+
+   ```bash
+   npm install
+   ```
+
+6. **Run Laravel migrations**:
+
+   ```bash
+   php artisan migrate
+   ```
+
+7. **Run the development server**:
+
+   ```bash
+   php artisan serve
+   ```
+
+### Additional Configuration
+
+#### `php.ini` Configuration
+
+Ensure the following extension is enabled in your `php.ini` file:
+
+```ini
+extension=zip
+```
+
+#### Pagination System
+
+To enable the pagination system, modify the `AppServiceProvider`:
+
+```php
+namespace App\Providers;
 
-The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+use Illuminate\Pagination\Paginator;
+use Illuminate\Support\ServiceProvider;
 
+class AppServiceProvider extends ServiceProvider
+{
+    public function boot(): void
+    {
+        Paginator::useBootstrap();
+    }
+}
+```
+
+## Laratrust User Configuration
+
+Ensure your `User` model is configured for Laratrust:
 
-## laratrustUser config;
+```php
 namespace App\Models;
 
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Foundation\Auth\User as Authenticatable;
 use Illuminate\Notifications\Notifiable;
 use Laratrust\Traits\HasRolesAndPermissions;
-
 use Laratrust\Contracts\LaratrustUser;
 
 class User extends Authenticatable implements LaratrustUser 
@@ -86,13 +133,11 @@ class User extends Authenticatable implements LaratrustUser
         'password',
     ];
 
-
     protected $hidden = [
         'password',
         'remember_token',
     ];
 
-
     protected function casts(): array
     {
         return [
@@ -101,22 +146,17 @@ class User extends Authenticatable implements LaratrustUser
         ];
     }
 }
+```
 
 
-php artisan key:generate<br>
-php artisan config:cach<br>
-php.ini/extension=zip<br>
-npm install<br>
-npm run dev <br>
+## License
 
-#### pagination system :
-#### if you need the pagination system please go ->Providers/AppServiceProvider and 
-     
-     use Illuminate\Pagination\Paginator;
-     
-     public function boot(): void
-    {
-        Paginator::useBootstrap();
-    }
-    past the code 
+This project is licensed under the MIT License.
+
+## Acknowledgments
+
+- **Laravel**: For backend development.
+- **Bootstrap** and **jQuery**: For frontend design.
+- **Laratrust**: For role and permission management.
 
+For any issues or feature requests, please open an issue in this repository. Happy coding!