Skip to content

Commit 7ddf48a

Browse files
committed
updated README.md
1 parent cd95e96 commit 7ddf48a

File tree

1 file changed

+57
-20
lines changed

1 file changed

+57
-20
lines changed

README.md

Lines changed: 57 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,46 @@
11
## Laravel AdminTW
22

3-
> From version 5 AdminTW is a complete project rather than a package. If you are looking for the package version, please use version 4.
3+
> **Note:** From version 5 AdminTW is a complete project rather than a package. If you are looking for the package version, please use version 4.
44
5-
Laravel AdminTW is a Laravel Livewire Starter Kit | TALL admin theme.
5+
Laravel AdminTW is a **Laravel Livewire Starter Kit** and a **TALL stack admin theme**, designed for rapid development and ease of use.
66

7-
<p><img src="https://laraveladmintw.com/images/docsv5/settings-light.png"></p>
7+
![AdminTW](https://laraveladmintw.com/images/docsv5/settings-light.png)
88

9-
AdminTw is built on top of Laravel, Livewire, and Tailwind CSS.
9+
AdminTW is built on top of **Laravel, Livewire, and Tailwind CSS**, offering a modern and efficient admin dashboard.
1010

11-
Includes:
12-
- 2FA
13-
- Audit Trails
14-
- System Settings
15-
- Multiple Users
16-
- Roles and Permissions
17-
- Tests
11+
### **Features**
12+
- **Two-Factor Authentication (2FA)**
13+
- **Audit Trails**
14+
- **System Settings**
15+
- **Multiple Users Support**
16+
- **Roles and Permissions Management**
17+
- **Comprehensive Test Suite (Pest PHP)**
18+
- **Light & Dark Mode Support** (based on user OS settings)
19+
- **Tests**
1820

19-
## Installation
21+
22+
## **Installation**
23+
24+
### **Using Laravel Installer (Recommended from Laravel Installer version 5.14)**
25+
26+
If you have Laravel Installer **5.14 or later**, you can quickly set up AdminTW with:
27+
28+
```bash
29+
laravel new my-project --using=dcblogdev/laravel-admintw
30+
```
31+
32+
### **Manual Installation**
2033

2134
1. Clone the repository
2235

2336
```bash
24-
git clone git@github.com:dcblogdev/laravel-admintw.git
37+
git clone git@github.com:dcblogdev/laravel-admintw.git my-project
2538
```
2639

2740
Open the project folder
2841

2942
```bash
30-
cd laravel-admintw
43+
cd my-project
3144
```
3245

3346
Copy the `.env.example` file to `.env`:
@@ -38,12 +51,36 @@ cp .env.example .env
3851

3952
Set database and emails settings inside `.env`
4053

41-
2. Run `composer install`
42-
3. Run `npm install && npm run build`
43-
4. run `php artisan key:generate`
44-
5. run `php artisan storage:link`
45-
6. Run `php artisan migrate --seed`
46-
7. Run `php artisan serve`
54+
Install PHP Dependencies
55+
56+
```bash
57+
composer install
58+
```
59+
60+
Install JavaScript Dependencies & Build Assets
61+
```bash
62+
npm install && npm run build
63+
```
64+
65+
Generate Application Key
66+
```bash
67+
php artisan key:generate
68+
```
69+
70+
Create Storage Symlink
71+
```bash
72+
php artisan storage:link
73+
```
74+
75+
Run Database Migrations & Seed Data
76+
```bash
77+
php artisan migrate --seed
78+
```
79+
80+
Start the Development Server
81+
```bash
82+
php artisan serve
83+
```
4784

4885
Laravel AdminTW supports both light and dark mode based on the users OS.
4986

0 commit comments

Comments
 (0)