You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-2Lines changed: 31 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,6 +26,36 @@ To install the starter kit, run the following command:
26
26
27
27
Visit the URL for your app and you're good to go!
28
28
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.
58
+
29
59
## Icons
30
60
31
61
This starter kit leverages the [Lucide Vue Library](https://lucide.dev/guide/packages/lucide-vue-next), which provides you with a collection of over 1000 icons. View the full list of icons [here](https://lucide.dev/icons).
@@ -44,5 +74,4 @@ Here's a quick example of using an icon in one of your Vue Components:
0 commit comments