How jordanhilado/portfolio-website works
Main Components
• Next.js Application Shell:
• Core Next.js “app” directory as the heart of your application (found in src/app). This is where the layout and routing are defined (layout.tsx and page.tsx).
• UI Components Layer:
• A component layer that contains reusable UI elements (components/ui/) and global/component-level providers (e.g., theme-provider.tsx, mode-toggle.tsx).
• Assets and Static Files:
• Location for static assets (public folder and src/assets) where resources (images, PDF resumes, fonts, etc.) reside.
• Utility and Library Functions:
• Utils in src/lib which provide helper methods and shared logic across the application.
• Configuration and Build Tooling:
• Configuration files (e.g., next.config.js, tailwind.config.ts, tsconfig.json, postcss.config.js) as they influence the behavior of the build, styling, and type-checking processes.
• External Services and Deployment:
• Although not extensive, include a note about deployment practices (as suggested in the README – “Deploy on Vercel”) and integration points such as Next.js API routes (if used in future expansion).
Relationships and Interactions
• Routing and Page Rendering:
• Component Composition:
• Link high-level layout components with nested UI components found under src/components/ui, illustrating that these elements are nested to form pages.
• Static Assets and Data Flow:
• Use of static assets from the public folder and dynamic data or utility functions from src/assets/data.ts or src/lib/utils.ts that feed into component rendering.
• Dependency on Third-Party Libraries:
• How Next.js, Tailwind CSS, and other libraries (as seen from configuration files) are integrated and affect the overall system.
Architectural Patterns and Design Principles
• Convention over Configuration:
• The project leverages Next.js’s opinionated structure for improved developer experience.
• Component-based Design:
• That UI is built as composable and modular units (components paired with a theme provider for state and style management).
• Declarative Data Flow:
Detail Level
• Be very detailed and capture the essential architectural elements:
• Separate out each component into as many logical parts as possible.
• Including potential state management handled in the theme provider or other hooks if applicable.
• Custom utilities or integrations that are unique to this project structure.