PAWfect Match

PAWfect Match is a personalized pet matchmaking service designed to connect potential pet owners with pets that best suit their lifestyle, living conditions, and available resources. This app promotes responsible pet ownership by factoring in preferences such as living space, financial capabilities, and time availability.

Table of Contents

• Demo
• Features
• Tech Stack
• Getting Started
• Available Scripts
• Contributing

Demo

A live demo will be provided soon. Stay tuned!

Features

• Personalized pet matchmaking algorithm
• Dynamic and responsive user interface
• Survey form to assess potential pet owners' lifestyle and financial status
• Pet profiles with real-time data from external APIs
• Ongoing support and resources for responsible pet ownership

Tech Stack

• Frontend: Vite, React
• Styling: Bootstrap, Sass, Material UI
• Animations: Framer Motion
• APIs: RescueGroups API (for fetching pet profiles)

Getting Started

Prerequisites

Make sure you have the following installed:

• Node.js (v16 or higher recommended)
• npm (v7 or higher)

Installation

1. Clone the repository:

   git clone https://github.com/imaesp/PAWfect-Match.git cd pawfect-match

2. Install dependencies:

   npm install

3. Run the development server:

   npm run dev

4. Open your browser and navigate to http://localhost:5173.

Styling

• Tailwind CSS has been set up for utility-first CSS styling.
• Material UI components are used for reusable UI components.
• Sass is used for additional styling flexibility.
• Framer Motion is included for interactive animations.

Available Scripts

• npm run dev: Starts the development server.
• npm run build: Builds the app for production.
• npm run preview: Previews the production build locally.
• npm run lint: Lints the project.

Contributing

• Imanol Espinal - imaesp
• Sania Pervez - sanipervez
• Zainib Mohammad - zainibm
• Leyanna Daniels - LeyannaD