# πΎ Pawtect - Where Pets Find Their Forever Homes
[](https://opensource.org/licenses/MIT)
[](https://reactjs.org/)
[](https://nodejs.org/)
[](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-
Backend Setup
cd server node server.js -
Frontend Setup
cd client npm install npm start -
Chatbot Setup
cd server pip install -r requirements.txt uvicorn app:app --reload
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
Key Endpoints:
POST /api/pets- Add new pet listingGET /api/pets?type=dog- Filter petsPOST /api/lost-reports- File lost pet reportPOST /api/donations- Process donations
# 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# Run backend tests
cd server
npm test
# Run frontend tests
cd client
npm test-
Frontend Deployment
cd client npm run build # Upload build/ to hosting (Netlify/Vercel)
-
Backend Deployment
- Deploy to Render/Heroku
- Configure MongoDB Atlas connection
- Set environment variables
-
Chatbot Deployment
- Containerize with Docker
- Deploy to Python hosting (PythonAnywhere)
Project Maintainers:
- Romysa Siddiqui - [romysasidd21@gmail.com]
- Anza Malik - [anza.mk8142@gmail.com]
Project Link: https://github.com/futuremango/Pawtect-FYP