Skip to content

Commit 4541a0e

Browse files
committed
Adding readme info for Vue Starter Kit
1 parent 71577e7 commit 4541a0e

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

README.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,36 @@ 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.
58+
2959
## Icons
3060

3161
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:
4474
<Rocket />
4575
<span class="text-lg font-medium">Vue Starter Kit</span>
4676
</p>
47-
</template>
48-
```
77+
</template>

0 commit comments

Comments
 (0)