Skip to content

Commit 0b14561

Browse files
committed
Add README.md ✨
1 parent f1e7c70 commit 0b14561

File tree

9 files changed

+296
-1
lines changed

9 files changed

+296
-1
lines changed

.src/Screenshot/dashboard.png

138 KB
Loading

.src/Screenshot/home.png

197 KB
Loading

.src/Screenshot/login.png

637 KB
Loading

.src/Screenshot/register.png

547 KB
Loading

.src/logo.svg

Lines changed: 1 addition & 0 deletions
Loading

README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<p align="center"></br><img src="./.src/logo.svg" width="100" height="100" alt="sumer5020"></p>
2+
<p align="center">
3+
<a href="https://choosealicense.com/licenses/mit/"><img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License"></a>
4+
<a href="#"><img src="https://img.shields.io/badge/Type-Nuxt_WEB_&_Laravel_API_Template-black" alt="Repository Type"></a>
5+
<a href="#"><img src="https://img.shields.io/badge/Latest_Version-0.0.1-blue" alt="Latest Version"></a>
6+
</br></br></br></br>
7+
</p>
8+
9+
# Starter Kit for Laravel and Nuxt3
10+
11+
An Open Source Project designed to provide our fellow developers/students a better way to get started.
12+
13+
## Content
14+
15+
| Project | Type | Description |
16+
| :-------- | :------------ | :------------------------------ |
17+
| `api.app` | `Laravel` | **Required**. PHP ^8.1 |
18+
| `app` | `Nuxt3` | **Required**. Node ^v18.0.0 |
19+
20+
21+
## Features
22+
- api.app
23+
- Laravel breeze api
24+
- Http response helper
25+
- Activity log helper
26+
- Collection manager helper
27+
- Htaccess firewall
28+
- app
29+
- Responsive design
30+
- Light/dark mode toggle
31+
- Tailwindcss
32+
- Multilingual
33+
- Auth pages
34+
- Dashboard
35+
- Toast notification
36+
37+
38+
## Theme Color Reference
39+
40+
| Color | | Hex |
41+
| :---------------- | :-------------------------------------------------------:| :-------|
42+
| Dark theme: | | |
43+
| Primary | ![#b4c9d9](https://via.placeholder.com/10/b4c9d9?text=+) | #b4c9d9 |
44+
| Secondary | ![#0b4b7d](https://via.placeholder.com/10/0b4b7d?text=+) | #0b4b7d |
45+
| Background | ![#090b1f](https://via.placeholder.com/10/090b1f?text=+) | #090b1f |
46+
| Light theme: | | |
47+
| Primary | ![#203552](https://via.placeholder.com/10/203552?text=+) | #203552 |
48+
| Secondary | ![#0b4b7d](https://via.placeholder.com/10/0b4b7d?text=+) | #0b4b7d |
49+
| Background | ![#f0f4f3](https://via.placeholder.com/10/f0f4f3?text=+) | #f0f4f3 |
50+
51+
## Screenshots
52+
53+
<p align="center">
54+
<img width="400" height="300" src="./.src/Screenshot/home.png" alt="Home Screenshot">
55+
<img width="400" height="300" src="./.src/Screenshot/login.png" alt="Login Screenshot">
56+
<img width="400" height="300" src="./.src/Screenshot/register.png" alt="Register Screenshot">
57+
<img width="400" height="300" src="./.src/Screenshot/dashboard.png" alt="Dashboard Screenshot">
58+
</p>
59+
60+
61+
## Setup And Run
62+
63+
Test the app by run the following command:
64+
65+
```bash
66+
# API
67+
composer install --working-dir=./api.app
68+
php ./api.app/artisan migrate
69+
php ./api.app/artisan db:seed
70+
php ./api.app/artisan serve
71+
72+
# WEB
73+
npm install -D --prefix ./app
74+
npm run dev -prefix ./app
75+
```
76+
77+
## Feedback
78+
79+
If you have any feedback, please reach out to us at sumer5020@outlook.com

0 commit comments

Comments
 (0)