Skip to content

billymcmonkeys/pawlo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

6 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🐾 Pawlo

AI-Powered Lost Pet Reunification Platform

Reunite. Rescue. Repeat.

Next.js TypeScript Tailwind CSS License

Live Demo β€’ Report Bug β€’ Request Feature


πŸ“– About This Project

Pawlo is a mobile-first web application designed to help reunite lost pets with their owners through AI-powered photo matching and community collaboration. Built with modern web technologies, Pawlo connects neighborhoods to bring pets back home safely and quickly.

🎨 Created by MC Monkeys

This project was built by MC Monkeys β€” where humans and AI agents collaborate to build real-world digital solutions. MC Monkeys is the team behind Mission Control for Claude Code, a system that makes AI agent work visible in real time.

Pawlo was developed using this human-AI collaborative approach, combining strategic planning, modern development practices, and operational visibility to deliver a production-ready application.

Learn more: https://mcmonkeys.up.railway.app/


✨ Features

  • πŸ” AI Photo Matching β€” Upload a photo of a found pet and get instant matches with registered pets
  • πŸ“± Mobile-First Design β€” Optimized for on-the-go pet spotting and reporting
  • πŸ• Pet Registration β€” Easy 4-step process to register your pet with photos and details
  • 🏘️ Neighborhood Network β€” Connect with your community to help lost pets
  • 🎯 Smart Filtering β€” Search by breed, size, color, and location
  • ⚑ Real-Time Status β€” Track pets as Lost, Safe, or Reunited
  • πŸ“Š Success Stories β€” View reunited pets and community impact statistics
  • 🎨 Beautiful UI β€” Modern, accessible design with smooth animations

πŸ› οΈ Tech Stack

Technology Purpose
Next.js 14 React framework with App Router for optimal performance
TypeScript Type-safe development and better developer experience
Tailwind CSS Utility-first styling with custom design tokens
Lucide React Beautiful, consistent icons
Vercel Deployment platform (recommended)

πŸ“‹ Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v18.17 or higher)
  • npm (v9 or higher) or yarn / pnpm
  • Git for version control

πŸš€ Installation

Follow these steps to get Pawlo running on your local machine:

1. Clone the Repository

git clone https://github.com/billymcmonkeys/pawlo.git
cd pawlo

2. Install Dependencies

npm install

Or if you prefer yarn:

yarn install

3. Run the Development Server

npm run dev

Or with yarn:

yarn dev

4. Open in Browser

Navigate to http://localhost:3000 to see the application running.

The page will automatically reload when you make changes to the code.


πŸ“± How to Use

For Pet Owners

  1. Register Your Pet

    • Navigate to the registration flow (/register)
    • Upload 3-5 clear photos of your pet
    • Fill in details (name, breed, size, color, distinctive features)
    • Add your contact information
    • Review and submit
  2. Mark as Lost (if needed)

    • Go to your pet's profile
    • Update status to "Lost"
    • Your neighborhood will be notified automatically
  3. Reunite

    • When your pet is found, update status to "Reunited"
    • Share your success story!

For Community Members

  1. Found a Pet?

    • Go to /found/upload
    • Upload a photo of the found pet
    • Add location details
    • Submit for AI matching
  2. Review Matches

    • View similarity-ranked results
    • Contact the most likely owner
    • Help reunite pets with their families

πŸ“‚ Project Structure

pawlo/
β”œβ”€β”€ app/                      # Next.js App Router
β”‚   β”œβ”€β”€ layout.tsx            # Root layout
β”‚   β”œβ”€β”€ page.tsx              # Home page
β”‚   β”œβ”€β”€ how-it-works/         # Information pages
β”‚   β”œβ”€β”€ register/             # Pet registration flow
β”‚   β”‚   β”œβ”€β”€ step-1/           # Photo upload
β”‚   β”‚   β”œβ”€β”€ step-2/           # Pet details
β”‚   β”‚   β”œβ”€β”€ step-3/           # Owner info
β”‚   β”‚   └── review/           # Final review
β”‚   β”œβ”€β”€ found/                # Found pet flow
β”‚   β”‚   β”œβ”€β”€ upload/           # Upload found pet photo
β”‚   β”‚   β”œβ”€β”€ processing/       # AI matching process
β”‚   β”‚   β”œβ”€β”€ results/          # Match results
β”‚   β”‚   └── match/[id]/       # Individual match details
β”‚   └── pets/[id]/            # Pet profile pages
β”œβ”€β”€ components/               # Reusable React components
β”‚   β”œβ”€β”€ Navbar.tsx
β”‚   β”œβ”€β”€ PetCard.tsx
β”‚   β”œβ”€β”€ StatusBadge.tsx
β”‚   β”œβ”€β”€ HeroCarousel.tsx
β”‚   └── ...
β”œβ”€β”€ data/                     # Mock data (Phase 0)
β”‚   β”œβ”€β”€ pets.ts               # Sample pets data
β”‚   └── mock-results.ts       # Sample match results
β”œβ”€β”€ lib/                      # Utility functions
β”‚   β”œβ”€β”€ pets.ts               # Pet data helpers
β”‚   β”œβ”€β”€ matches.ts            # Matching logic
β”‚   └── store.ts              # State management
β”œβ”€β”€ docs/                     # Documentation
β”‚   β”œβ”€β”€ architecture.md       # Technical architecture
β”‚   β”œβ”€β”€ wireframe-*.md        # Design wireframes
β”‚   └── ...
β”œβ”€β”€ public/                   # Static assets
β”œβ”€β”€ next.config.js            # Next.js configuration
β”œβ”€β”€ tailwind.config.ts        # Tailwind + design tokens
└── tsconfig.json             # TypeScript configuration

🎯 Available Scripts

Command Description
npm run dev Start development server at localhost:3000
npm run build Create optimized production build
npm run start Start production server
npm run lint Run ESLint to check code quality
npm run typecheck Run TypeScript type checking

πŸ—ΊοΈ Roadmap

Phase 0 (Current) β€” Frontend Prototype

  • βœ… Responsive UI/UX
  • βœ… Mock data structure
  • βœ… Complete user flows
  • βœ… Design system implementation

Phase 1 β€” Backend Integration

  • ⏳ Database setup (Prisma + PostgreSQL)
  • ⏳ REST API endpoints
  • ⏳ Real data persistence
  • ⏳ User authentication

Phase 2 β€” AI Integration

  • ⏳ Real AI photo matching API
  • ⏳ Improved matching algorithms
  • ⏳ Confidence scoring

Phase 3 β€” Advanced Features

  • ⏳ Push notifications
  • ⏳ Geolocation services
  • ⏳ In-app messaging
  • ⏳ Social sharing
  • ⏳ Multi-language support

🌟 Key Features in Detail

AI Photo Matching

Upload a photo and our AI compares it against registered pets, ranking matches by similarity score based on visual features like:

  • Breed characteristics
  • Coat color and patterns
  • Size and body structure
  • Distinctive markings

Multi-Step Registration

A user-friendly 4-step wizard guides pet owners through registration:

  1. Photo Upload β€” Multiple angles for better matching
  2. Pet Details β€” Comprehensive information capture
  3. Owner Contact β€” Secure contact method storage
  4. Review β€” Verify before submission

Community Dashboard

View neighborhood statistics:

  • Total pets reunited
  • Average reunification time
  • Active registered pets
  • Lost pet alerts

πŸ› Known Issues & Limitations

Current Limitations (Phase 0)

  • No Backend: All data is mock/static
  • No Persistence: Refreshing the page resets state
  • No Authentication: No user accounts or login
  • Simulated AI: Matches are pre-defined, not computed

These limitations are intentional for the prototype phase and will be addressed in future updates.


🀝 Contributing

We welcome contributions! If you'd like to contribute:

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Please ensure your code follows the existing style and passes all linting checks.


πŸ“„ License

This project is licensed under the MIT License β€” see the LICENSE file for details.


πŸ“ž Contact & Support

Project Creator: MC Monkeys

MC Monkeys is a human-AI collaborative system building real-world digital solutions. The team uses Claude Code agents with full operational visibility through Mission Control.

Need Help?


πŸ™ Acknowledgments

  • Built using human-AI collaborative workflows with Claude Code agents
  • Developed with full operational visibility through MC Monkeys Mission Control
  • Pet photos courtesy of Unsplash and placeholder services
  • Icons by Lucide
  • Inspired by real-world pet reunification challenges
  • Built with ❀️ for pet lovers everywhere

🐾 Help us bring more pets home safely! 🐾

Visit MC Monkeys | Star this repo ⭐

Built with human-AI collaboration by MC Monkeys 🐡

Making AI agent work visible. One project at a time.

About

🐾 AI-powered platform to reunite lost pets with their owners through photo matching and community collaboration. Mobile-first Next.js app. Created by MC Monkeys.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors