cleaning up and documentating

Author: tnylea

README.md

@@ -44,8 +44,9 @@ resources/js/
 ├── components/     # Reusable Vue components
 ├── composables/    # Vue composables/hooks
 ├── layouts/        # Application layouts
+├── lib/           # Utility functions and configurations
 ├── pages/         # Page components
-└── lib/           # Utility functions and configurations
+└── types/         # Typescript definitions and interfaces
 ```
 
 **Components**: Use PascalCase for component files

resources/js/components/NavUser.vue

@@ -2,6 +2,7 @@
 import { defineComponent } from 'vue';
 import { ChevronsUpDown, LogOut, Settings } from 'lucide-vue-next';
 import { Link, usePage } from '@inertiajs/vue3';
+import { User } from '@/types';
 import {
     Avatar,
     AvatarFallback,
@@ -22,12 +23,6 @@ import {
     SidebarMenuItem,
 } from '@/components/ui/sidebar';
 
-interface User {
-    name: string;
-    email: string;
-    avatar?: string;
-}
-
 function getInitials(fullName: string): string {
     const names = fullName.trim().split(' ');
     if (names.length === 0) return '';

resources/js/types/index.ts

@@ -1,5 +1,9 @@
 import { LucideIcon } from 'lucide-react'
 
+export interface Auth {
+    user: User
+}
+
 export interface BreadcrumbItem {
     title: string
     href: string