English | 中文

PawHaven Backend

✨ What is this?

This is the backend service for PawHaven, a compassionate full-stack platform for rescuing stray animals.
It is built with NestJS and designed with a modular, scalable architecture.

It provides secure and efficient APIs for the frontend, handles data storage, authentication, and background jobs — ensuring that the PawHaven ecosystem runs smoothly.

---

🌟 Project Overview

PawHaven Backend is the heart of our mission: to unite tech with compassion.
It manages all server-side logic, from user authentication and rescue record management to notifications and community interactions.

For developers, it’s also a practical learning project to master backend development, API design, and cloud deployment.

---

🚀 Features

• User Authentication & Authorization — JWT-based login, role-based permissions
• Rescue Record Management — Create, read, update, and delete animal rescue records
• Location Services — Store and query sightings based on geolocation
• Email Notifications — Send invitations and updates to volunteers
• Short Link Service — Generate and manage short URLs for rescue cases
• RPC Communication — Internal microservices communication support
• Database Access — PostgreSQL with Prisma ORM (or chosen DB)

---

🛠️ Technology Stack

• Backend Framework: NestJS, Node.js
• API Types: REST & RPC
• Database: PostgreSQL + Prisma ORM
• Auth: JWT-based authentication with role management
• Deployment: Kubernetes, Docker, GitHub Actions CI/CD
• Other Tools: pnpm, class-validator, class-transformer

---

🤝 Join Our Caring Community

If you’re passionate about backend development and helping animals, PawHaven Backend is the perfect place to contribute!
You’ll learn how to design clean, scalable APIs while supporting a meaningful cause.

---

📩 How to Contribute

1. Fork the repository and create your feature branch.
2. Submit pull requests with clear descriptions of your improvements.
3. Report issues or suggest features via GitHub Issues.
4. Help improve documentation and API tests.

---

🔗 Links

• Frontend Repo: https://github.com/aoda-zhang/PawHaven-frontEnd
• Backend Repo: https://github.com/aoda-zhang/PawHaven-backEnd

---

Thank you for supporting PawHaven — where technology meets compassion! 🐾❤️

---