AlexJSully-Portfolio

AlexJSully’s Portfolio Documentation

This documentation explains the architecture and usage of AlexJSully’s Portfolio—a Next.js-based portfolio website showcasing projects, publications, and professional work.

What This Portfolio Does

The portfolio is a client-side rendered application that displays:

• Projects: Interactive grid showing employment history and personal projects with video previews
• Publications: Academic publications with DOIs and abstracts
• Profile: Animated avatar with Easter egg interactions
• Analytics: User interaction tracking via Firebase
• PWA Support: Installable web app with offline capabilities

For External Users

If you want to use this portfolio template for your own site:

• Setup & Installation — Get started with local development
• Adding Projects — Customize the projects grid
• Testing Guide — Run tests and validation

For Internal Developers

If you’re maintaining or extending this codebase:

• Architecture Overview — System design and patterns
• Component Documentation — UI component behaviors
• Data Architecture — How data flows through the application

Architecture

• Architecture Overview
• App Directory (Next.js)
• Constants
• Data Architecture
• Helpers
• Images & Icons
• Layouts
• PWA & Service Workers
• Configs
• Utils
• Detailed Components

Usage Guides

• Usage Overview
• Setup & Installation
• Testing Guide

Key Features

• Network-Aware Loading: Adapts video autoplay based on connection speed
• Easter Egg: Hidden interaction triggered by avatar hover
• Progressive Web App: Installable with offline support via service worker
• Analytics Tracking: Firebase integration for user behavior insights
• Accessibility: ARIA labels, semantic HTML, and keyboard navigation

Contributing & Code of Conduct

• Contributing Guide
• Code of Conduct

This site is open source. Improve this page.