https://github.com/shahalimshompod/pet-promise-client
Pet Promise is a platform simplifying pet care, adoption, and donation campaigns, making it easy to adopt, donate, or support pet welfare.
https://github.com/shahalimshompod/pet-promise-client
axios css3 dotenv expressjs firebase-auth html5 javascript jwt-token mongodb-atlas nodejs npm-package reactjs reactrouter rest-api tailwindcss tanstack-query
Last synced: 4 months ago
JSON representation
Pet Promise is a platform simplifying pet care, adoption, and donation campaigns, making it easy to adopt, donate, or support pet welfare.
- Host: GitHub
- URL: https://github.com/shahalimshompod/pet-promise-client
- Owner: shahalimshompod
- Created: 2025-02-05T16:50:59.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-17T23:53:02.000Z (4 months ago)
- Last Synced: 2025-02-18T00:25:07.935Z (4 months ago)
- Topics: axios, css3, dotenv, expressjs, firebase-auth, html5, javascript, jwt-token, mongodb-atlas, nodejs, npm-package, reactjs, reactrouter, rest-api, tailwindcss, tanstack-query
- Language: JavaScript
- Homepage: https://pet-promise.web.app/
- Size: 17.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🐾 Pet Promise
**Pet Promise** is a comprehensive platform designed to make pet care, pet adoption, and pet donation campaigns easier and more accessible for everyone. Whether you're looking to adopt a pet, start a donation campaign, or contribute to the welfare of pets, **Pet Promise** has you covered.
---
## 📸 Screenshot
---
## 🚀 Technologies Used
Pet Promise is built using the following technologies:
- **Frontend:** [React](https://react.dev/), [React Router](https://reactrouter.com/), [Framer Motion](https://www.framer.com/motion/), [React Hook Form](https://react-hook-form.com/)
- **State Management & API Handling:** [React Query](https://tanstack.com/query/latest/), [Axios](https://axios-http.com/)
- **UI Components & Styling:** [Tailwind CSS](https://tailwindcss.com/), [Flowbite React](https://flowbite-react.com/), [React Icons](https://react-icons.github.io/react-icons/), [React Select](https://react-select.com/)
- **Authentication & Backend:** [Firebase](https://firebase.google.com/)
- **Payments:** [Stripe](https://stripe.com/)
- **Other Libraries:** [React Quill](https://react-quill.js.org/), [React Lottie](https://lottiefiles.com/web-player), [React Spinners](https://www.npmjs.com/package/react-spinners), [SweetAlert2](https://sweetalert2.github.io/), [DOMPurify](https://www.npmjs.com/package/dompurify)
---
## 🌟 Features
✅ **Adopt a Pet** – Browse and adopt pets easily.
✅ **Start a Donation Campaign** – Create and manage pet donation campaigns.
✅ **Secure Payments** – Integrated Stripe payment system for donations.
✅ **Interactive UI** – Smooth animations with Framer Motion.
✅ **Advanced Search & Filtering** – Find pets based on preferences.
✅ **Rich Text Editing** – Manage posts with React Quill.
✅ **Real-time Updates** – Optimized with React Query.
---
## 📦 Dependencies
### Main Dependencies
```json
{
"@stripe/react-stripe-js": "^3.1.1",
"@stripe/stripe-js": "^5.5.0",
"@tanstack/react-query": "^5.64.1",
"@tanstack/react-table": "^8.20.6",
"axios": "^1.7.9",
"firebase": "^11.1.0",
"framer-motion": "^12.0.6",
"react": "^18.3.1",
"react-dom": "^18.3.1",
"react-hook-form": "^7.54.2",
"react-icons": "^5.4.0",
"react-router-dom": "^7.1.1",
"react-quill": "^2.0.0",
"react-select": "^5.9.0",
"react-spinners": "^0.15.0",
"sweetalert2": "^11.15.10",
"tailwind-scrollbar": "^3.1.0"
}
```
## 📦 Development Dependencies:
```json
{
"@eslint/js": "^9.17.0",
"@vitejs/plugin-react": "^4.3.4",
"eslint": "^9.17.0",
"postcss": "^8.5.0",
"tailwindcss": "^3.4.17",
"vite": "^6.0.5"
}
```
# 🛠 How to Run the Project Locally
Follow these steps to set up and run the project on your local machine:
### 1️⃣ Clone the Repository
```sh
git clone https://github.com/shahalimshompod/pet-promise-client
cd pet-promise
```
### 2️⃣ Install Dependencies
```sh
npm install
```
### 3️⃣ Run the Development Server
```sh
npm run dev
```
### 4️⃣ Build the Project (Optional)
```sh
npm run build
```
### 5️⃣ Preview the Build (Optional)
```sh
npm run preview
```
---
## 🌍 Live Demo
🔗 **Live Project:** [Pet Promise](https://pet-promise.web.app/)
---
## 📌 Notes
1️⃣ Ensure you have **Node.js** and **npm** installed before running the project.
2️⃣ If you face issues, check your **Firebase** and **Stripe** configuration settings.
---
## 👥 Contributors
👤 **Shah Alim Shompod**
🔗 [GitHub Profile](https://github.com/shahalimshompod)
---
## 📜 License
This project is licensed under the **MIT License**.
---