added readme

README.md

@@ -1 +1,105 @@
 ## Creditzombies
+A web application to upload report from another application and generate report based on client information in the system.
+
+------------------------------------------------------------------------
+## 🏗 Project Architecture
+
+    app/
+    │
+    ├── Http/
+    │   ├── Controllers/
+    │   └── Requests/
+    ├── Models/
+    ├── Providers/
+    ├── Services/
+    │    
+    routes/
+    ├── web.php
+
+
+------------------------------------------------------------------------
+
+## ⚙️ Requirements
+
+-   PHP ≥ 8.1
+-   Composer
+-   MySQL
+-   Laravel 8
+-   wkhtmltopdf
+
+------------------------------------------------------------------------
+
+## 🛠 Installation
+
+``` bash
+git clone <repository-url>
+cd <project-name>
+
+composer install
+cp .env.example .env
+php artisan key:generate
+```
+## Snappy pdf binary file
+``` bash
+Add snappy pdf binary file inside C:\wkhtmltopdf which added in onedrive
+```
+### Database
+
+Import database script inside file location database>>ceditzombiesdb.sql
+
+------------------------------------------------------------------------
+
+## ▶️ Running the Project
+
+``` bash
+php artisan serve
+```
+
+Base API URL:
+
+    http://127.0.0.1:8000
+
+------------------------------------------------------------------------
+
+## 📄 Key Features
+``` bash
+1. Users Role : Admin, Employee, Client
+```
+``` bash
+  Admin or Employee Panel
+  
+  1. Client Management 
+     Admin or Employee Can Add, Edit, View and Delete client.
+     
+  2. Employee Management
+     Admin or Permitted Employee Can Add, Edit, View and Delete employee.
+     
+  3. Sales Report 
+     Admin or Permitted Employee Can View sales report.
+     
+  4. Client Support
+     Admin or Permitted Employee Can reply the client support.   
+```         
+
+``` bash
+  Client Panel
+  
+  1. Account Information 
+     Client Can Add, Update his/her information.
+     
+  2. Work Area
+     Client can upload their credit report and generate report in this section.
+  
+  3. Make Payment
+     Client can make payment using payment setting.
+        
+  4. Support
+     Client Can create the support ticket.   
+```    
+
+``` bash
+1. Client can apply using registration form 
+```  
+
+
+