Skip to content

Pawtect – A pet adoption & rescue platform built with React, Node.js, MongoDB & Python chatbot. Features: adopt, rescue, lost/found pets, donations & surrender. Connecting pets with loving homes. 🐾 #SavePets

License

Notifications You must be signed in to change notification settings

futuremango/Pawtect-FYP

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

25 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Pawtect - Pet Rescue & Adoption Platform πŸ•πŸˆ

# 🐾 Pawtect - Where Pets Find Their Forever Homes

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![React](https://img.shields.io/badge/React-18.2-blue)](https://reactjs.org/)
[![Node.js](https://img.shields.io/badge/Node.js-16.x-green)](https://nodejs.org/)
[![MongoDB](https://img.shields.io/badge/MongoDB-6.0-brightgreen)](https://www.mongodb.com/)

Pawtect is a comprehensive pet rescue and adoption platform connecting loving homes with pets in need. Our mission is to reduce stray animal populations through adoption, rescue coordination, and community support.

## 🌟 Key Features

- **Pet Adoption Network** - Browse adoptable pets with filters
- **Lost & Found System** - Report and search for missing pets
- **Rescue Coordination** - Connect with local rescue organizations
- **Donation Portal** - Support animal welfare initiatives
- **Surrender Assistance** - Responsible pet rehoming process
- **AI-Powered Chatbot** - 24/7 pet care assistance

## πŸ› οΈ Tech Stack

| Component       | Technology                 |
|-----------------|----------------------------|
| Frontend        | React.js, Redux, TailwindCSS |
| Backend         | Node.js, Express.js        |
| Database        | MongoDB Atlas              |
| AI Chatbot      | Python (TensorFlow/NLTK)   |
| Authentication  | JWT, OAuth 2.0            |
| Payment Gateway | Stripe Integration        |

## πŸš€ Getting Started

### Prerequisites
- Node.js v16+
- MongoDB Atlas account
- Python 3.8+ (for chatbot)

### Installation

1. **Clone the repository**
   ```bash
   git clone https://github.com/futuremango/Pawtect-FYP.git
   cd Pawtect-FYP
  1. Backend Setup

    cd server
    node server.js
  2. Frontend Setup

    cd client
    npm install
    npm start
  3. Chatbot Setup

    cd server
    pip install -r requirements.txt
    uvicorn app:app --reload

πŸ“‚ Project Structure

Pawtect-FYP/
β”œβ”€β”€ client/               # React frontend
β”‚   β”œβ”€β”€ public/           # Static assets
β”‚   └── src/              # React components
β”‚       β”œβ”€β”€ components/   # Reusable UI
β”‚       β”œβ”€β”€ pages/        # Route pages
β”‚       └── styles/        # Redux configuration
β”œβ”€β”€ server/               # Node.js backend
β”‚   β”œβ”€β”€ controllers/      # Business logic
β”‚   β”œβ”€β”€ models/           # MongoDB schemas
β”‚   β”œβ”€β”€ routes/           # API endpoints
β”‚   └── middleware/       # Authentication
β”‚   β”œβ”€β”€ model/            # ML models
β”‚   └── training_data/    # Chatbot datasets
└── docs/                 # Documentation

🌐 API Documentation

View Complete API Docs

Key Endpoints:

  • POST /api/pets - Add new pet listing
  • GET /api/pets?type=dog - Filter pets
  • POST /api/lost-reports - File lost pet report
  • POST /api/donations - Process donations

πŸ›‘οΈ Environment Variables

# Server
MONGO_URI=mongodb+srv://user:pass@cluster.mongodb.net/pawtect
JWT_SECRET=your_jwt_secret_here
STRIPE_KEY=sk_test_stripe_key

# Client
REACT_APP_API_URL=https://api.pawtect.example.com
REACT_APP_MAPBOX_KEY=pk.mapbox_key

🚧 Testing

# Run backend tests
cd server
npm test

# Run frontend tests
cd client
npm test

πŸš€ Deployment Guide

  1. Frontend Deployment

    cd client
    npm run build
    # Upload build/ to hosting (Netlify/Vercel)
  2. Backend Deployment

    • Deploy to Render/Heroku
    • Configure MongoDB Atlas connection
    • Set environment variables
  3. Chatbot Deployment

    • Containerize with Docker
    • Deploy to Python hosting (PythonAnywhere)

βœ‰οΈ Contact

Project Maintainers:

Project Link: https://github.com/futuremango/Pawtect-FYP


About

Pawtect – A pet adoption & rescue platform built with React, Node.js, MongoDB & Python chatbot. Features: adopt, rescue, lost/found pets, donations & surrender. Connecting pets with loving homes. 🐾 #SavePets

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages