diff --git a/README.md b/README.md index 645a0bb..c98bfd6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# 🐾 paw❀️print +# FosterFlow -**Open-source rescue management platform β€” self-host free or use PawPrint Cloud.** +**Open-source rescue management platform β€” self-host free or use FosterFlow Cloud.** Modern, fast, mobile-first website and management system built for animal rescues. Everything a foster-based rescue needs, nothing it doesn't. @@ -8,16 +8,16 @@ Modern, fast, mobile-first website and management system built for animal rescue ## What It Does -- πŸ• **Pet Management** β€” Profiles, photos, medical records, foster assignments, status tracking -- πŸ“‹ **Applications** β€” Adoption, foster, volunteer, surrender forms with configurable questions -- 🏠 **Foster Portal** β€” Dedicated dashboard for fosters to submit updates, photos, supply requests -- πŸ’° **Donations & Expenses** β€” Stripe payments, multi-source tracking, financial reports -- πŸ“… **Events** β€” Listings with optional Facebook auto-posting -- ✏️ **Content CMS** β€” Editable page sections, newsletter, happy tails / success stories -- πŸ“Š **Analytics** β€” Human traffic, bot detection, honeypot, AI job tracking -- πŸ” **Role-Based Access** β€” 9 roles from sysadmin to foster with granular permissions -- πŸ€– **Bot Protection** β€” Dynamic robots.txt, honeypot tarpit, managed blocklist/whitelist -- 🧠 **AI Features** β€” Pet name generator (Ollama), expandable job queue +- **Pet Management** β€” Profiles, photos, medical records, foster assignments, status tracking +- **Applications** β€” Adoption, foster, volunteer, surrender forms with configurable questions +- **Foster Portal** β€” Dedicated dashboard for fosters to submit updates, photos, supply requests +- **Donations & Expenses** β€” Stripe payments, multi-source tracking, financial reports +- **Events** β€” Listings with optional Facebook auto-posting +- **Content CMS** β€” Editable page sections, newsletter, happy tails / success stories +- **Analytics** β€” Human traffic, bot detection, honeypot, AI job tracking +- **Role-Based Access** β€” 9 roles from sysadmin to foster with granular permissions +- **Bot Protection** β€” Dynamic robots.txt, honeypot tarpit, managed blocklist/whitelist +- **AI Features** β€” Pet name generator (Ollama), expandable job queue ## Tech Stack @@ -31,34 +31,59 @@ Modern, fast, mobile-first website and management system built for animal rescue ## SaaS Architecture -PawPrint supports multi-tenant deployment: +FosterFlow supports multi-tenant deployment: - **Self-hosted** β€” One rescue, one server, free forever -- **PawPrint Cloud** β€” Automated onboarding, subdomain provisioning, managed hosting +- **FosterFlow Cloud** β€” Automated onboarding, subdomain provisioning, managed hosting See [docs/SAAS.md](docs/SAAS.md) for the multi-tenant architecture. See [docs/ONBOARDING.md](docs/ONBOARDING.md) for automated provisioning. -## Quick Start (Self-Hosted) +## Quick Start (Docker) + +The fastest way to get running: ```bash -git clone https://github.com/yourusername/pawprint -cd pawprint +git clone https://github.com/yourusername/fosterflow +cd fosterflow cp .env.example .env -# Edit .env with your database URL, SMTP, etc. +# Edit .env β€” set SESSION_SECRET and SITE_DOMAIN at minimum +docker compose up +``` + +On first run, migrate and seed the database: + +```bash +docker compose exec app npx drizzle-kit push +docker compose exec app npx tsx scripts/seed.ts +``` + +Then open `http://localhost:3000` and log in with `admin@example.com` / `changeme`. + +## Quick Start (Manual) + +```bash +git clone https://github.com/yourusername/fosterflow +cd fosterflow +cp .env.example .env +# Edit .env with your database URL, SMTP settings, etc. npm install npx drizzle-kit push -npm run seed +npx tsx scripts/seed.ts npm run dev ``` -## PawPrint Cloud Pricing +## Self-Hosted vs FosterFlow Cloud -| Plan | Price | What You Get | -|------|-------|-------------| -| **Self-Hosted** | Free | Full source, you manage everything | -| **PawPrint Cloud** | $19/mo | Managed hosting, subdomain, SSL, backups, updates | -| **Setup Assist** | $50 one-time | We migrate your data from your old site | +| | Self-Hosted | FosterFlow Cloud | +|---|---|---| +| **Cost** | Free | $19/mo | +| **Hosting** | You manage | Fully managed | +| **SSL** | You configure | Automatic | +| **Backups** | You configure | Daily, included | +| **Updates** | Manual | Automatic | +| **Subdomain** | Your domain | yourrescue.fosterflow.app | +| **Setup assist** | Community support | $50 one-time migration | ## License @@ -66,4 +91,4 @@ MIT β€” use it, fork it, save some dogs. --- -Built with ❀️ by [JRei](https://reiners.dev) β€” started as Almost Home Canine Rescue's website, now open for every rescue. +Built with love by [JRei](https://reiners.dev) β€” started as Almost Home Canine Rescue's website, now open for every rescue.