Skip to content

Commit b2d7cee

Browse files
committed
Adding update to readme
1 parent 4541a0e commit b2d7cee

File tree

1 file changed

+37
-29
lines changed

1 file changed

+37
-29
lines changed

README.md

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -26,35 +26,43 @@ To install the starter kit, run the following command:
2626

2727
Visit the URL for your app and you're good to go!
2828

29-
## JS Folder Structure
30-
31-
We follow Vue.js best practices and conventions for organizing the files and folders inside the `resources/js` directory. The structure follows these naming conventions:
32-
33-
- **Folders**: Use kebab-case
34-
```
35-
resources/js/
36-
├── components/ # Reusable Vue components
37-
├── composables/ # Vue composables/hooks
38-
├── layouts/ # Application layouts
39-
├── pages/ # Page components
40-
└── lib/ # Utility functions and configurations
41-
```
42-
43-
- **Components**: Use PascalCase for component files
44-
```
45-
components/
46-
└── AppearanceTabs.vue
47-
└── NavigationBar.vue
48-
```
49-
50-
- **Composables/Utilities**: Use camelCase for utility files and composables
51-
```
52-
composables/
53-
└── useAuth.ts
54-
└── useSettings.ts
55-
```
56-
57-
This structure aligns more with the default Vue convention.
29+
## Features
30+
31+
This Starter Kit includes the following features:
32+
33+
- **User Authentication** (login, register, password reset, email verify, and password confirmation)
34+
- **Dashboard Page** (Auth Protected User Dashboard Page)
35+
- **Settings Page** (Profile Update/Delete, Password Update, Appearance)
36+
37+
## Front-end App Structure
38+
39+
The majority of the front-end code is located in the `resources/js` folder. We follow Vue.js best practices and conventions for organizing the files and folders inside this folder. The structure follows these naming conventions:
40+
41+
**Folders**: Use kebab-case
42+
```
43+
resources/js/
44+
├── components/ # Reusable Vue components
45+
├── composables/ # Vue composables/hooks
46+
├── layouts/ # Application layouts
47+
├── pages/ # Page components
48+
└── lib/ # Utility functions and configurations
49+
```
50+
51+
**Components**: Use PascalCase for component files
52+
```
53+
components/
54+
└── AppearanceTabs.vue
55+
└── NavigationBar.vue
56+
```
57+
58+
**Composables/Utilities**: Use camelCase for utility files and composables
59+
```
60+
composables/
61+
└── useAuth.ts
62+
└── useSettings.ts
63+
```
64+
65+
This structure aligns more with the default Vue conventions.
5866

5967
## Icons
6068

0 commit comments

Comments
 (0)