Petbound 🐾

The adoption website exclusively for animals at risk of euthanasia.

Purpose

In the U.S., countless adoptable animals face this devastating outcome due to overcrowded shelters. Petbound directly addresses this crisis by providing a focused, up-to-date, and accessible directory of animals needing urgent placement. Our goal is to connect these vulnerable pets with loving homes, saving lives one adoption at a time.

Tech Stack + Project Architecture

Frontend

• Next.js (App Router): This is our main framework, providing a fast and clean user interface.
• TypeScript (TS): TypeScript is used to ensure a higher level of build quality and to catch simple bugs.

Backend + Data Collection

• Supabase: This is our backend. It handles the database (PostgreSQL), provides easy-to-use APIs, and manages user login. It also has edge functions and cron jobs that clean data.
• Automated Data Pipeline (Python & GitHub Actions):
  • Python with BeautifulSoup4: We use Python to run a web-scraper that collects data that is then stored in our database.
  • GitHub Actions: This allows us to automate our data collection and create a self-sufficient database with up to date and cleaned data.

🛠️ Getting Started (Local Development)

To run Petbound on your local machine, follow these steps.

Prerequisites

• Node.js (LTS version recommended)
• A package manager like npm, yarn, pnpm, or bun.

1. Clone the Repository

git clone git@github.com:Petbound-org/petbound-web.git
cd petbound

2. Install Dependencies

npm install
# or
yarn install
# or
pnpm install
# or
bun install

3. Connect to Supabase

Create your own supabase project and store your anon key, service role key, and supabase url in a .env file.

4. Run your Server!

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev