Skip to content

Commit 65d28ab

Browse files
morpheusadammorpheusadam
committed
Rewrite README
1 parent b804c2d commit 65d28ab

1 file changed

Lines changed: 64 additions & 128 deletions

File tree

‎README.md‎

Lines changed: 64 additions & 128 deletions
Original file line numberDiff line numberDiff line change
@@ -1,104 +1,41 @@
1-
<div align="center">
2-
# 📊 RTL Forge
3-
### A fully responsive, feature-rich Laravel admin dashboard built for right-to-left (RTL) languages — Arabic, Persian, and Hebrew.
4-
5-
<p>
6-
<img src="https://img.shields.io/github/license/morpheusadam/RtlForge?style=for-the-badge&color=4c1" alt="License" />
7-
<img src="https://img.shields.io/github/stars/morpheusadam/RtlForge?style=for-the-badge&color=ffca28" alt="Stars" />
8-
<img src="https://img.shields.io/github/forks/morpheusadam/RtlForge?style=for-the-badge&color=42a5f5" alt="Forks" />
9-
<img src="https://img.shields.io/github/last-commit/morpheusadam/RtlForge?style=for-the-badge&color=8e44ad" alt="Last commit" />
10-
<img src="https://img.shields.io/github/repo-size/morpheusadam/RtlForge?style=for-the-badge&color=e67e22" alt="Repo size" />
11-
</p>
12-
13-
<p>
14-
<img src="https://img.shields.io/badge/PHP-8.2+-777BB4?style=for-the-badge&logo=php&logoColor=white" alt="PHP" />
15-
<img src="https://img.shields.io/badge/Laravel-11-FF2D20?style=for-the-badge&logo=laravel&logoColor=white" alt="Laravel" />
16-
<img src="https://img.shields.io/badge/Livewire-3-4E56A6?style=for-the-badge&logo=livewire&logoColor=white" alt="Livewire" />
17-
<img src="https://img.shields.io/badge/Bootstrap-RTL-7952B3?style=for-the-badge&logo=bootstrap&logoColor=white" alt="Bootstrap RTL" />
18-
<img src="https://img.shields.io/badge/MySQL-Database-4479A1?style=for-the-badge&logo=mysql&logoColor=white" alt="MySQL" />
19-
</p>
20-
21-
</div>
22-
23-
---
24-
25-
## 📖 Overview
26-
27-
**RTL Dashboard** is a fully responsive, feature-rich **admin dashboard template** designed specifically for **right-to-left (RTL) languages**. Built on the latest **Laravel 11** and **Livewire**, it delivers a seamless, intuitive experience for users who prefer RTL layouts — making it an ideal foundation for **Arabic, Persian, Hebrew**, and other RTL-language applications.
28-
29-
Beyond the polished UI, it ships with a complete back end: a full blog with articles, categories and comments, a menu builder, custom pages, an advertising system, a support-ticket system, smart traffic and error tracking, and a modular plugin architecture (powered by `nwidart/laravel-modules`). Role and permission management (Spatie), media handling, multi-language content, and API documentation via Swagger come built in.
30-
31-
It is perfect for **developers, agencies, and SaaS builders** who need a production-ready, RTL-first dashboard with statistics, notifications, and a clean, extensible structure.
1+
# RTL Forge
322

33-
> 🔎 **Keywords:** rtl dashboard, laravel admin panel, rtl admin template, persian dashboard, arabic dashboard, laravel 11 dashboard, livewire admin, responsive admin template, rtl ui, php dashboard.
3+
RTL Forge (project name `RTL Dashboard`) is a Laravel 11 admin dashboard template built for right-to-left languages such as Arabic, Persian, and Hebrew, aimed at developers and agencies who need an RTL-first back office.
344

35-
---
5+
## Overview
366

37-
## ✨ Features
38-
39-
- 🌐 **RTL-first design** — fully responsive layouts tailored for Arabic, Persian, and Hebrew.
40-
- 🔍 **Smart SEO** — automatic SEO optimization, `robots.txt`, and a sitemap generator.
41-
- 🔔 **Real-time notifications & alerts** — rich notifications with images, plus instant, automatic error alerts.
42-
- 🖼️ **Media management** — professional image handling with drag-and-drop uploads (Spatie Media Library).
43-
- 🧩 **Menu & page builder** — create menus, order links by drag-and-drop, and build custom pages from templates.
44-
- 📰 **Full blog** — articles, categories, comments, and tags.
45-
- 📣 **Advertising system** — built-in ad placements.
46-
- 🎫 **Support tickets** — a contact/ticketing system for user communication.
47-
- 📈 **Dashboard analytics** — traffic, top pages, browsers, devices, operating systems, and more.
48-
- 🔗 **Link redirection** — manage and track redirects.
49-
- 🛡️ **Security** — advanced permissions, rate limiting, custom 404 pages, and Cloudflare-ready setup.
50-
- 👥 **User system** — profiles with avatars, login, registration, and email confirmation.
51-
- ⚙️ **Site settings** — central configuration for the whole application.
52-
- 🌍 **Multi-language content** — translatable models via Spatie Translatable.
53-
- 📱 **PWA-ready** — `manifest.json` for installable mobile experiences.
54-
- 🔌 **Plugin & module system** — extend functionality with self-contained modules.
55-
- 📚 **API docs** — interactive documentation via L5-Swagger.
56-
57-
---
58-
59-
## 🛠️ Tech Stack
60-
61-
<p align="center">
62-
<img src="https://skillicons.dev/icons?i=laravel,php,mysql,bootstrap,js" alt="Tech stack" />
63-
</p>
64-
65-
| Layer | Technology |
66-
| --- | --- |
67-
| Framework | Laravel 11 (PHP 8.2+) |
68-
| UI | Livewire 3, Bootstrap (RTL), Blade |
69-
| Modules | `nwidart/laravel-modules` |
70-
| Permissions | `spatie/laravel-permission` |
71-
| Media | `spatie/laravel-medialibrary`, Intervention Image |
72-
| i18n | `spatie/laravel-translatable` |
73-
| Notifications | Toastr |
74-
| Geolocation | `stevebauman/location` |
75-
| API Docs | L5-Swagger |
7+
The template is a responsive admin dashboard built on Laravel 11 and Livewire 3, with layouts designed for RTL rather than mirrored from an LTR design.
768

77-
---
9+
Behind the UI it ships a working back end: a blog with articles, categories and comments, a menu builder, custom pages, an advertising system, a support-ticket system, traffic and error tracking, and a module system based on `nwidart/laravel-modules`. Role and permission management (Spatie), media handling, multi-language content, and Swagger API documentation are included.
7810

79-
## 🖼️ Screenshots
11+
## Features
8012

81-
<p align="center">
82-
<img src="public/images/screenshots/1.png" width="45%" alt="RTL Dashboard screenshot" />
83-
<img src="public/images/screenshots/2.png" width="45%" alt="RTL Dashboard screenshot" />
84-
</p>
85-
<p align="center">
86-
<img src="public/images/screenshots/3.png" width="45%" alt="RTL Dashboard screenshot" />
87-
<img src="public/images/screenshots/4.png" width="45%" alt="RTL Dashboard screenshot" />
88-
</p>
13+
- RTL-first responsive layouts for Arabic, Persian, and Hebrew
14+
- SEO handling with `robots.txt` and a sitemap generator
15+
- Notifications with images, and automatic error alerts
16+
- Media management with drag-and-drop uploads (Spatie Media Library)
17+
- Menu builder with drag-and-drop ordering, plus custom pages from templates
18+
- Blog with articles, categories, comments, and tags
19+
- Advertising placements
20+
- Support ticket and contact system
21+
- Dashboard analytics: traffic, top pages, browsers, devices, operating systems
22+
- Link redirection management and tracking
23+
- Permissions, rate limiting, custom 404 pages, and Cloudflare-ready setup
24+
- User profiles with avatars, login, registration, and email confirmation
25+
- Central site settings
26+
- Multi-language content via Spatie Translatable
27+
- PWA `manifest.json` for installable mobile use
28+
- Module system for self-contained features
29+
- API documentation via L5-Swagger
8930

90-
---
31+
## Requirements
9132

92-
## 🚀 Getting Started
33+
- PHP 8.2 or later
34+
- Composer
35+
- MySQL, or another supported database
36+
- The `php-imagick` extension
9337

94-
### Prerequisites
95-
96-
- **PHP 8.2+**
97-
- **Composer**
98-
- **MySQL** (or another supported database)
99-
- **php-imagick** extension
100-
101-
### Installation
38+
## Installation
10239

10340
```bash
10441
# Install the image extension (Debian/Ubuntu)
@@ -121,19 +58,19 @@ php artisan queue:work
12158
php artisan schedule:run
12259
```
12360

124-
### Default Credentials
61+
### Default credentials
12562

12663
| Field | Value |
12764
| --- | --- |
12865
| Login URL | `http://127.0.0.1:8000/login` |
12966
| Email | `admin@admin.com` |
13067
| Password | `password` |
13168

132-
---
69+
## Usage
13370

134-
## ⚙️ Layout Sections
71+
### Layout sections
13572

136-
Blade layouts expose the following yield points for easy extension:
73+
The Blade layouts expose these yield points for extension:
13774

13875
```blade
13976
@yield('styles')
@@ -142,9 +79,32 @@ Blade layouts expose the following yield points for easy extension:
14279
@yield('scripts')
14380
```
14481

145-
---
82+
## Screenshots
14683

147-
## 🗂️ Project Structure
84+
<p align="center">
85+
<img src="public/images/screenshots/1.png" width="45%" alt="RTL Dashboard screenshot" />
86+
<img src="public/images/screenshots/2.png" width="45%" alt="RTL Dashboard screenshot" />
87+
</p>
88+
<p align="center">
89+
<img src="public/images/screenshots/3.png" width="45%" alt="RTL Dashboard screenshot" />
90+
<img src="public/images/screenshots/4.png" width="45%" alt="RTL Dashboard screenshot" />
91+
</p>
92+
93+
## Tech stack
94+
95+
| Layer | Technology |
96+
| --- | --- |
97+
| Framework | Laravel 11 (PHP 8.2+) |
98+
| UI | Livewire 3, Bootstrap (RTL), Blade |
99+
| Modules | `nwidart/laravel-modules` |
100+
| Permissions | `spatie/laravel-permission` |
101+
| Media | `spatie/laravel-medialibrary`, Intervention Image |
102+
| i18n | `spatie/laravel-translatable` |
103+
| Notifications | Toastr |
104+
| Geolocation | `stevebauman/location` |
105+
| API docs | L5-Swagger |
106+
107+
## Project structure
148108

149109
```text
150110
rtl-dashboard/
@@ -159,38 +119,14 @@ rtl-dashboard/
159119
└── database/ # Migrations & seeders
160120
```
161121

162-
---
163-
164-
## 🤝 Contributing
165-
166-
Contributions are welcome! Please read [`CONTRIBUTING.md`](CONTRIBUTING.md) and the [Code of Conduct](CODE_OF_CONDUCT.md), then open an [issue](https://github.com/morpheusadam/RtlForge/issues) or submit a pull request.
122+
## Contributing
167123

168-
## 📜 License
124+
Read [`CONTRIBUTING.md`](CONTRIBUTING.md) and the [Code of Conduct](CODE_OF_CONDUCT.md), then open an [issue](https://github.com/morpheusadam/RtlForge/issues) or submit a pull request.
169125

170-
Distributed under the **MIT License**. See [`LICENSE.md`](LICENSE.md) for details.
126+
## License
171127

172-
---
173-
174-
## ⭐ Star History
175-
176-
<a href="https://star-history.com/#morpheusadam/RtlForge&Date">
177-
<img src="https://api.star-history.com/svg?repos=morpheusadam/RtlForge&type=Date" alt="Star History Chart" width="600" />
178-
</a>
179-
180-
---
181-
182-
<div align="center">
183-
184-
### 👤 Author — Morpheus Adam
185-
186-
Web developer & cheerful hacker · PHP · Laravel · Go
187-
188-
<p>
189-
<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>
190-
<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>
191-
<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>
192-
</p>
128+
MIT. See [`LICENSE.md`](LICENSE.md) for details.
193129

194-
⭐ **If this dashboard helped you, consider giving it a star!** ⭐
130+
## Author
195131

196-
</div>
132+
Morpheus Adam — [GitHub](https://github.com/morpheusadam) · [sam.zeonic.me](https://sam.zeonic.me) · morpheusadam95@gmail.com

0 commit comments

Comments
 (0)