Skip to content

Petfolio Knowledge Base

Welcome to the Petfolio Knowledge Base - your comprehensive guide to the Petfolio frontend monorepo!

What is Petfolio?

Petfolio is a modern pet portfolio platform built with cutting-edge technologies:

  • Next.js 16 with App Router
  • React 19 for modern UI development
  • Material UI 7 component library
  • TypeScript 5.9 in strict mode
  • Nx 22 monorepo management

  • Getting Started

    Set up your development environment and start contributing

    Installation

  • Architecture

    Understand the monorepo structure and design patterns

    Overview

  • Development

    Learn workflows, testing strategies, and best practices

    Workflows

  • Components

    Explore the component library and theme system

    Library

Features Demonstrated

This knowledge base showcases several MkDocs Material features:

Mermaid Diagrams

graph LR
    A[Developer] --> B{Nx Monorepo}
    B --> C[petfolio-business]
    B --> D[ui-component-library]
    B --> E[util-global-theme]
    B --> F[petfolio-docs]
    C --> G[Production Deploy]
    F --> H[GitHub Pages]

Code Blocks with Syntax Highlighting

import { ThemeProvider } from '@util-global-theme';
import { Button } from '@ui-component-library';

export function App() {
  return (
    <ThemeProvider>
      <Button variant="contained">Click me!</Button>
    </ThemeProvider>
  );
}

Admonitions

!!! tip "Pro Tip" Use nx affected:test to only run tests for changed projects!

!!! warning "Important" Always respect module boundary rules enforced by ESLint.

!!! info "Did you know?" This documentation is version-controlled and deployed automatically to GitHub Pages!

HTML & iFrame Support

You can embed HTML wireframes and prototypes directly in the documentation. See the Wireframes section for examples.

Contributing

Found an error or want to improve the docs? Click the edit icon on any page to suggest changes!

Version

Current version: latest

This documentation uses versioning powered by mike, allowing you to maintain docs for multiple versions of the project.