Skip to content

Commit 8cd3ba5

Browse files
committed
Adding updates to the react starter kit
1 parent 50076b6 commit 8cd3ba5

File tree

2 files changed

+45
-7
lines changed

2 files changed

+45
-7
lines changed

README.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://cdn.devdojo.com/assets/svg/laravel-react-logo.svg" width="300" alt="Laravel Logo"></a></p>
22

33
<p align="center">
4-
<a href="github.com/laravel/react-starter-kit/actions"><img src="https://github.com/laravel/react-starter-kit/workflows/tests/badge.svg" alt="Build Status"></a>
4+
<a href="https://github.com/laravel/react-starter-kit/actions"><img src="https://github.com/laravel/react-starter-kit/workflows/tests/badge.svg" alt="Build Status"></a>
55
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
66
</p>
77

88
## Introduction
99

10-
Welcome to the Laravel React Starter Kit. This starter kit utilizes Intertia v2, Tailwind V3 (soon to be V4), React 19, and ShadCN UI.
10+
Welcome to the <a href="https://laravel.com" target="_blank">Laravel</a> React</a> Starter Kit. This starter kit utilizes <a href="https://inertiajs.com/" target="_blank">Intertia v2</a>, <a href="https://tailwindcss.com/" target="_blank">Tailwind CSS</a>,V3 (soon to be V4), <a href="https://reactjs.dev" target="_blank">React 19</a>, and <a href="https://ui.shadcn.com/" target="_blank">ShadCN UI</a>.
1111

1212
## Installation
1313

@@ -29,6 +29,15 @@ This shell file will run the following commands, which you may wish to run manua
2929
5. npm install
3030
6. npm run dev
3131

32+
## Features
33+
34+
This Starter Kit includes the following features:
35+
36+
- **User Authentication** (login, register, password reset, email verify, and password confirmation)
37+
- **Dashboard Page** (Auth Protected User Dashboard Page)
38+
- **Settings Page** (Profile Update, Password Update, Delete Account)
39+
40+
3241

3342
## Front-end App Structure
3443

@@ -56,10 +65,40 @@ This code will load the `resources/js/Pages/Dashboard.tsx` file.
5665

5766
### Layouts
5867

59-
All your pages will utilize a layout as the structure for each page. These layout files are located in the `resources/js/Layouts` folder. Currently, there are two layouts, `AppLayout` and `AuthLayout`.
68+
All your pages will utilize a layout as the structure for each page. These layout files are located in the `resources/js/Layouts` folder. Currently, there will be two layouts. An `App` layout and an `Auth` layout.
6069

6170
1. **AppLayout** - This layout will be used for all authenticated users.
62-
2. **AuthLayout** - This layout will be used for unauthenticated users and this layout is used specifically for all the Authentication views.
71+
2. **Auth\AuthBase** - This is the main layout for your authentication pages, more info below.
72+
73+
### Authentication Layouts
74+
75+
The Authentication layouts are used specifically for all the Authentication views. You'll notice that there are a few different layouts in the `resources/js/Layouts/Auth` folder. This is because we provide you with three layouts to choose from.
76+
77+
#### AuthSimpleLayout.tsx
78+
79+
A clean and simple layout for your authentication pages.
80+
81+
![Simple Auth Layout Screenshot](https://cdn.devdojo.com/images/december2024/simple-layout.png)
82+
83+
#### AuthCardLayout.tsx
84+
85+
A layout with a slightly darker background and with the auth form inside a card.
86+
87+
![Simple Auth Layout Screenshot](https://cdn.devdojo.com/images/december2024/card-layout.png)
88+
89+
#### SplitLayout.tsx
90+
91+
A split view authentication layout screen
92+
93+
![Simple Auth Layout Screenshot](https://cdn.devdojo.com/images/december2024/split-layout.png)
94+
95+
---
96+
97+
To change the Layout you would like to use, simply change the Layout file that is imported in the **AppBase.tsx**. As an example, to use the `AuthSplitLayout.tsx`, the first line would be modified to look like the following:
98+
99+
```tsx
100+
import AuthLayoutTemplate from "@/Layouts/Auth/AuthSplitLayout";
101+
```
63102

64103
---
65104

resources/js/Layouts/Auth/AuthSplitLayout.tsx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,17 @@ import ApplicationLogo from "@/Components/ApplicationLogo"
33

44
interface AuthLayoutProps {
55
children: React.ReactNode
6-
name?: string
76
title?: string
87
description?: string
98
}
109

1110
export default function AuthSplitLayout({
1211
children,
1312
title,
14-
description,
15-
name
13+
description
1614
}: AuthLayoutProps) {
1715
const quote = usePage().props.quote;
16+
const name = usePage().props.name;
1817

1918
return (
2019
<div className="px-8 sm:px-0 relative h-dvh flex-col items-center justify-center grid lg:max-w-none lg:grid-cols-2 lg:px-0">

0 commit comments

Comments
 (0)