|
1 | | -# Route Rider System |
| 1 | +# Route Rider System 🚴♂️ |
2 | 2 |
|
3 | | -This project was built on Mosand Workshop Day. |
| 3 | +A modern and powerful web application built with **Laravel**, **Tailwind CSS**, and **Filament**. This system streamlines the management of route riders with a rich set of features, a responsive UI, and full support for both Arabic and English. |
4 | 4 |
|
5 | | -## This project built with Laravel + Tailwind + Filament <br> |
| 5 | +## ✨ Features |
6 | 6 |
|
7 | | -- Arabic and English support |
8 | | -- Has a landing page |
9 | | -- Dashboard support with statistical features |
10 | | -- Ability to register & recover passwords |
11 | | -- Ability to change theme settings |
12 | | -- Support roles and permissions |
13 | | -- Support Light & Dark theme |
14 | | -- Support Soft delete and recovery tasks |
15 | | -- If you like this work you can <a href="https://github.com/akramghaleb">see more here</a> |
| 7 | +- 🌍 **Multilingual**: Supports both Arabic and English |
| 8 | +- 🎯 **Landing Page**: Clean, responsive design |
| 9 | +- 📊 **Dashboard**: Powerful analytics and stats |
| 10 | +- 🔐 **Authentication**: Register, login, and password recovery |
| 11 | +- 🎨 **Customizable Themes**: Switch between Light & Dark mode |
| 12 | +- 👥 **Roles & Permissions**: Fine-grained access control |
| 13 | +- ♻️ **Soft Deletes**: Recover deleted data with ease |
| 14 | +- 🧠 **Built with Laravel, Tailwind CSS, and Filament** |
16 | 15 |
|
17 | | -## Installation |
| 16 | +> If you like this work, you can explore more on my [GitHub profile](https://github.com/akramghaleb) 🚀 |
18 | 17 |
|
19 | | -Clone the repository |
| 18 | +--- |
20 | 19 |
|
21 | | -``` |
| 20 | +## ⚙️ Installation Guide |
| 21 | + |
| 22 | +Clone the repository: |
| 23 | + |
| 24 | +```bash |
22 | 25 | git clone https://github.com/akramghaleb/Route-Rider-System.git |
| 26 | +cd Route-Rider-System |
23 | 27 | ``` |
24 | 28 |
|
25 | | -Install all the dependencies using the composer |
| 29 | +Install PHP dependencies via Composer: |
26 | 30 |
|
27 | | -``` |
| 31 | +```bash |
28 | 32 | composer install |
29 | 33 | ``` |
30 | 34 |
|
31 | | -Copy the example env file and make the required configuration changes in the .env file |
| 35 | +Copy and configure the environment file: |
32 | 36 |
|
33 | | -``` |
| 37 | +```bash |
34 | 38 | cp .env.example .env |
35 | 39 | ``` |
36 | 40 |
|
37 | | -Generate a new application key |
| 41 | +Generate the application key: |
38 | 42 |
|
39 | | -``` |
| 43 | +```bash |
40 | 44 | php artisan key:generate |
41 | 45 | ``` |
42 | 46 |
|
43 | | -Run the database migrations (**Set the database connection in .env before migrating**) |
| 47 | +Configure your database in `.env`, then run migrations and seeders: |
44 | 48 |
|
45 | | -``` |
| 49 | +```bash |
46 | 50 | php artisan migrate --seed |
47 | 51 | ``` |
48 | 52 |
|
| 53 | +Install front-end dependencies: |
49 | 54 |
|
50 | | -Make sure to install the dependencies: |
51 | 55 | ```bash |
52 | | -# npm |
| 56 | +# Choose one of the following: |
53 | 57 | npm install |
54 | | - |
55 | | -# pnpm |
56 | | -pnpm install |
57 | | - |
58 | | -# yarn |
| 58 | +# or |
59 | 59 | yarn install |
60 | | - |
61 | | -# bun |
| 60 | +# or |
| 61 | +pnpm install |
| 62 | +# or |
62 | 63 | bun install |
63 | 64 | ``` |
64 | 65 |
|
65 | | -Build your code: |
| 66 | +Build the assets: |
66 | 67 |
|
67 | 68 | ```bash |
68 | | -# npm |
| 69 | +# Choose the appropriate command based on your package manager |
69 | 70 | npm run build |
70 | | - |
71 | | -# pnpm |
72 | | -pnpm run build |
73 | | - |
74 | | -# yarn |
| 71 | +# or |
75 | 72 | yarn build |
76 | | - |
77 | | -# bun |
| 73 | +# or |
| 74 | +pnpm run build |
| 75 | +# or |
78 | 76 | bun run build |
79 | 77 | ``` |
80 | 78 |
|
81 | | -Start the local development server |
| 79 | +Run the development server: |
82 | 80 |
|
83 | | -``` |
| 81 | +```bash |
84 | 82 | php artisan serve |
85 | 83 | ``` |
86 | 84 |
|
87 | | -You can now access the server at http://localhost:8000 |
| 85 | +Visit your app at [http://localhost:8000](http://localhost:8000) |
88 | 86 |
|
89 | | - |
90 | | -password: password |
| 87 | +🧪 Default login: |
| 88 | + |
| 89 | +- **Password**: `password` |
91 | 90 |
|
92 | | -<br> |
| 91 | +--- |
93 | 92 |
|
94 | | -[Github Repo](https://github.com/akramghaleb/Route-Rider-System) |
| 93 | +## 📸 Screenshots |
95 | 94 |
|
96 | | -Thanks, |
97 | | - |
98 | | -If you enjoy my work, consider buying me a coffee to keep the creativity flowing! |
99 | | - |
100 | | -<a href="https://www.buymeacoffee.com/akramghaleb" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Coffee" width="150" ></a> |
101 | | -<br><br> |
102 | 95 | | Web Screens | |
103 | 96 | |-------------------------------------| |
104 | | -|| |
105 | | -|| |
106 | | -|| |
107 | | -|| |
108 | | -|| |
109 | | -|| |
110 | | -|| |
111 | | -|| |
112 | | -|| |
113 | | -|| |
114 | | -|| |
115 | | -|| |
116 | | -|| |
117 | | -|| |
118 | | -|| |
119 | | -|| |
120 | | -|| |
121 | | -|| |
122 | | -|| |
123 | | -|| |
124 | | -|| |
125 | | -|| |
126 | | - |
| 97 | +|  | |
| 98 | +|  | |
| 99 | +|  | |
| 100 | +|  | |
| 101 | +|  | |
| 102 | +|  | |
| 103 | +|  | |
| 104 | +|  | |
| 105 | +|  | |
| 106 | +|  | |
| 107 | +|  | |
| 108 | +|  | |
| 109 | +|  | |
| 110 | +|  | |
| 111 | +|  | |
| 112 | +|  | |
| 113 | +|  | |
| 114 | +|  | |
| 115 | +|  | |
| 116 | +|  | |
| 117 | +|  | |
| 118 | +|  | |
| 119 | + |
| 120 | +--- |
| 121 | + |
| 122 | +## ☕ Support |
| 123 | + |
| 124 | +If you found this project helpful or inspiring, consider buying me a coffee! |
| 125 | + |
| 126 | +[](https://www.buymeacoffee.com/akramghaleb) |
| 127 | + |
| 128 | +--- |
0 commit comments