Skip to content

Devpost-Hackathons/animal_hack_2025

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🐾 Adoptly - Pet Adoption Platform

A modern, responsive pet adoption platform built with Next.js that connects loving families with pets in need. Adoptly features a smart matching system, community feed, and comprehensive pet care cost calculator.

Adoptly Banner

✨ Features

🏠 Core Features

  • Pet Browsing: Browse available pets with detailed profiles, photos, and stories
  • Smart Matching Quiz: Lifestyle-based questionnaire that matches users with compatible pets
  • Community Feed: Share adoption stories, pet updates, and connect with the community
  • Authentication System: Secure login/signup with user profiles
  • Responsive Design: Optimized for desktop, tablet, and mobile devices

πŸ“± User Interface

  • Modern Menu System: Organized navigation with dropdown menus
  • Interactive Components: Modal dialogs for authentication and post creation
  • Gradient Design: Beautiful purple-to-pink gradient themes throughout
  • Glass-morphism Effects: Modern frosted glass design elements

πŸ’° Pet Care Cost Calculator

  • Monthly Cost Estimates: Food, veterinary care, supplies, and grooming costs in Indian Rupees (β‚Ή)
  • One-time Setup Costs: Adoption fees, initial supplies, spay/neuter, and microchipping
  • Financial Planning Tips: Emergency fund recommendations and pet insurance guidance

🧠 Smart Matching System

  • Lifestyle Assessment: Living space, activity level, experience, and time availability
  • Family Considerations: Kid-friendly pet recommendations
  • Compatibility Scoring: AI-powered matching algorithm
  • Personalized Results: Ranked pet recommendations based on user preferences

πŸ› οΈ Tech Stack

  • Frontend: Next.js 14, React 18, TypeScript
  • Styling: Tailwind CSS, CSS Custom Properties
  • UI Components: Custom components with Radix UI primitives
  • Icons: Lucide React
  • State Management: React Hooks (useState, useEffect)
  • Form Handling: Native React form handling
  • Image Optimization: Next.js Image component
  • Responsive Design: Mobile-first approach with Tailwind breakpoints

πŸ“ Project Structure

adoptly/
β”œβ”€β”€ app/                    # Next.js App Router
β”‚   β”œβ”€β”€ globals.css        # Global styles and Tailwind imports
β”‚   β”œβ”€β”€ layout.tsx         # Root layout with navigation
β”‚   β”œβ”€β”€ page.tsx          # Home page
β”‚   β”œβ”€β”€ api/              # API routes
β”‚   β”‚   β”œβ”€β”€ match/        # Pet matching algorithm
β”‚   β”‚   β”œβ”€β”€ pets/         # Pet data endpoints
β”‚   β”‚   └── stories/      # Community stories
β”‚   β”œβ”€β”€ feed/             # Community feed page
β”‚   β”œβ”€β”€ pets/             # Pet browsing page
β”‚   └── quiz/             # Pet matching quiz
β”œβ”€β”€ components/           # Reusable components
β”‚   β”œβ”€β”€ AuthModal.tsx     # Authentication modal
β”‚   β”œβ”€β”€ CreatePostModal.tsx # Post creation modal
β”‚   β”œβ”€β”€ Navigation.tsx    # Main navigation component
β”‚   └── ui/              # UI component library
β”œβ”€β”€ lib/                 # Utility functions
β”‚   β”œβ”€β”€ data.ts          # Mock data and API helpers
β”‚   └── utils.ts         # Utility functions (cn helper)
└── public/             # Static assets

πŸš€ Getting Started

Prerequisites

  • Node.js 18+
  • npm or yarn package manager

Installation

  1. Clone the repository

    git clone https://github.com/Hardik-S-003/animal_hack_2025.git
    cd animal_hack_2025/adoptly
  2. Install dependencies

    npm install
    # or
    yarn install
  3. Run the development server

    npm run dev
    # or
    yarn dev
  4. Open your browser Navigate to http://localhost:3000

Build for Production

npm run build
npm start

πŸ“± Pages & Features

🏑 Home Page

  • Hero section with call-to-action buttons
  • Statistics showcase (500+ adoptions, 50+ shelter partners)
  • Direct links to pet browsing and matching quiz

πŸ• Pet Browsing (/pets)

  • Grid layout of available pets
  • Pet cards with photos, names, ages, and tags
  • Interactive buttons for showing interest
  • Authentication required for pet interactions
  • Filter and search capabilities

🧠 Pet Matching Quiz (/quiz)

  • 5-question lifestyle assessment
  • Progress tracking
  • Radio button selection with descriptions
  • Comprehensive results with:
    • Top 3 pet matches with compatibility scores
    • Detailed cost breakdown in Indian Rupees
    • Financial planning recommendations
  • Retake quiz functionality

πŸ“° Community Feed (/feed)

  • User-generated content sharing
  • Photo upload functionality
  • Story creation modal
  • Interactive post actions (like, comment, share)
  • Real-time feed updates
  • Authentication required for posting

πŸ” Authentication System

Features

  • Modal-based Authentication: Clean, non-intrusive login/signup
  • Dual Mode Forms: Switch between login and signup seamlessly
  • Form Validation: Client-side validation with error handling
  • Session Management: Persistent login state
  • Protected Actions: Authentication required for posting and pet interactions

User Flow

  1. User clicks on protected action (post creation, pet interest)
  2. Authentication modal appears if not logged in
  3. User can register or login
  4. Upon success, original action proceeds automatically

πŸ’Έ Cost Calculator Features

Monthly Expenses (in β‚Ή)

  • Food: β‚Ή2,500 - β‚Ή6,500
  • Veterinary Care: β‚Ή4,000 - β‚Ή12,000
  • Supplies & Toys: β‚Ή1,500 - β‚Ή4,000
  • Grooming: β‚Ή2,500 - β‚Ή8,000

One-time Setup Costs (in β‚Ή)

  • Adoption Fee: β‚Ή4,000 - β‚Ή25,000
  • Initial Supplies: β‚Ή8,000 - β‚Ή16,000
  • Spay/Neuter: β‚Ή16,000 - β‚Ή40,000
  • Microchip: β‚Ή2,000 - β‚Ή4,000

Financial Recommendations

  • Emergency fund: β‚Ή80,000 - β‚Ή1,60,000
  • Pet insurance considerations
  • Monthly budgeting tips

🎨 Design System

Color Palette

  • Primary: Purple to Pink gradients (from-purple-600 to-pink-600)
  • Secondary: Blue to Indigo background gradients
  • Accent: Orange for highlights and CTAs
  • Neutral: Gray scale for text and borders

Typography

  • Font: Inter (Google Fonts)
  • Headings: Bold, gradient text effects
  • Body: Regular weight, optimized line height
  • UI Elements: Medium weight for buttons and labels

Components

  • Cards: Backdrop blur effects with transparency
  • Buttons: Gradient backgrounds with hover effects
  • Modals: Centered with backdrop blur
  • Forms: Clean inputs with focus states

🎯 API Endpoints

Pets (/api/pets)

  • GET: Returns list of available pets with photos and details
  • Includes pet information, stories, and adoption status

Stories (/api/stories)

  • GET: Returns community feed of adoption stories
  • POST: Creates new story posts with optional photo upload

Match (/api/match)

  • POST: Processes quiz responses and returns compatible pets
  • Includes affordability assessment and recommendations

πŸ“Š Key Improvements Made

πŸ”„ Recent Updates

  1. Fixed Styling Issues: Added PostCSS configuration for proper Tailwind CSS compilation
  2. Enhanced Navigation: Implemented dropdown menu structure for better organization
  3. Photo Upload: Working photo upload functionality in community feed
  4. Quiz Functionality: Fixed next button issues and added proper question navigation
  5. Authentication Flow: Modal-based authentication for protected actions
  6. Currency Localization: Changed cost calculator from USD to Indian Rupees (β‚Ή)
  7. Responsive Design: Improved mobile and desktop experiences

🀝 Contributing

We welcome contributions! Please follow these steps:

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

πŸ™ Acknowledgments

  • Unsplash for beautiful pet photography
  • Lucide for clean, consistent icons
  • Tailwind CSS for rapid UI development
  • Radix UI for accessible component primitives
  • Next.js team for the amazing framework

Thank You

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors