justin/fosterflow
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update README for FosterFlow branding

Browse Source 
Replaces PawPrint branding with FosterFlow throughout. Adds Docker quick start (docker compose up + seed commands), manual quick start, and a self-hosted vs FosterFlow Cloud comparison table. Removes emoji from feature list for cleaner rendering.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
justin
2026-03-26 12:49:50 -05:00
co-authored by Claude Sonnet 4.6
parent c129eecb15
commit 19665c4dd6
1 changed files with 51 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+51 -26
View File
@@ -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. 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 ## What It Does
- 🐕 **Pet Management** — Profiles, photos, medical records, foster assignments, status tracking - **Pet Management** — Profiles, photos, medical records, foster assignments, status tracking
- 📋 **Applications** — Adoption, foster, volunteer, surrender forms with configurable questions - **Applications** — Adoption, foster, volunteer, surrender forms with configurable questions
- 🏠 **Foster Portal** — Dedicated dashboard for fosters to submit updates, photos, supply requests - **Foster Portal** — Dedicated dashboard for fosters to submit updates, photos, supply requests
- 💰 **Donations & Expenses** — Stripe payments, multi-source tracking, financial reports - **Donations & Expenses** — Stripe payments, multi-source tracking, financial reports
- 📅 **Events** — Listings with optional Facebook auto-posting - **Events** — Listings with optional Facebook auto-posting
- ✏️ **Content CMS** — Editable page sections, newsletter, happy tails / success stories - **Content CMS** — Editable page sections, newsletter, happy tails / success stories
- 📊 **Analytics** — Human traffic, bot detection, honeypot, AI job tracking - **Analytics** — Human traffic, bot detection, honeypot, AI job tracking
- 🔐 **Role-Based Access** — 9 roles from sysadmin to foster with granular permissions - **Role-Based Access** — 9 roles from sysadmin to foster with granular permissions
- 🤖 **Bot Protection** — Dynamic robots.txt, honeypot tarpit, managed blocklist/whitelist - **Bot Protection** — Dynamic robots.txt, honeypot tarpit, managed blocklist/whitelist
- 🧠 **AI Features** — Pet name generator (Ollama), expandable job queue - **AI Features** — Pet name generator (Ollama), expandable job queue
## Tech Stack ## Tech Stack
@@ -31,34 +31,59 @@ Modern, fast, mobile-first website and management system built for animal rescue
## SaaS Architecture ## SaaS Architecture
PawPrint supports multi-tenant deployment: FosterFlow supports multi-tenant deployment:
- **Self-hosted** — One rescue, one server, free forever - **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/SAAS.md](docs/SAAS.md) for the multi-tenant architecture.
See [docs/ONBOARDING.md](docs/ONBOARDING.md) for automated provisioning. See [docs/ONBOARDING.md](docs/ONBOARDING.md) for automated provisioning.
## Quick Start (Self-Hosted) ## Quick Start (Docker)
The fastest way to get running:
```bash ```bash
git clone https://github.com/yourusername/pawprint git clone https://github.com/yourusername/fosterflow
cd pawprint cd fosterflow
cp .env.example .env 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 npm install
npx drizzle-kit push npx drizzle-kit push
npm run seed npx tsx scripts/seed.ts
npm run dev npm run dev
``` ```
## PawPrint Cloud Pricing ## Self-Hosted vs FosterFlow Cloud
| Plan | Price | What You Get | | | Self-Hosted | FosterFlow Cloud |
|------|-------|-------------| |---|---|---|
| **Self-Hosted** | Free | Full source, you manage everything | | **Cost** | Free | $19/mo |
| **PawPrint Cloud** | $19/mo | Managed hosting, subdomain, SSL, backups, updates | | **Hosting** | You manage | Fully managed |
| **Setup Assist** | $50 one-time | We migrate your data from your old site | | **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 ## 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.