Merge branch 'main' into pegasus-2026.6.2.5-1784730718.499782

Author: czue

README.md

@@ -1,6 +1,66 @@
-# Django Boilerplate
+# SaaS Pegasus Django Boilerplate (Open Source Edition)
 
-The original SaaS Boilerplate for Django, trusted by thousands.
+**The original SaaS boilerplate for Django — trusted by thousands.**
+
+A free, open-source, production-grade starting point for your next Django application. Spin up a
+Django app with a modern front-end stack and built-in essentials in minutes.
+Optimized for building in the AI-agent era.
+
+This is the **open-source edition** of [SaaS Pegasus](https://www.saaspegasus.com/), the Django SaaS
+boilerplate that has powered thousands of startups and products since 2019.
+It gives you a real, batteries-included foundation to build on, and a taste of the architecture,
+conventions, and tooling used by SaaS Pegasus projects.
+
+> **Looking for more?**
+> The pro version of SaaS Pegasus adds Stripe subscriptions, teams &
+> multi-tenancy, a host of AI and agent-based capabilities, one-click deployments, and much more.
+> **[See everything in SaaS Pegasus Pro →](https://www.saaspegasus.com/)**
+
+## What's included
+
+This boilerplate ships with a complete, modern Django foundation:
+
+- 🐍 **Django 6 on Python 3.14** — a clean, well-organized project structure following Django best practices.
+- 🔐 **Authentication** — sign-up, login, password reset, and email verification via [django-allauth](https://docs.allauth.org/).
+- ⚡ **HTMX + Alpine.js** — single-page-app interactivity without the single-page-app complexity.
+- 🎨 **Tailwind CSS v4 + DaisyUI** — a modern, themeable component library, integrated with [Vite](https://vite.dev/) via [django-vite](https://github.com/MrBin99/django-vite).
+- 🔌 **REST API** — built on [Django REST Framework](https://www.django-rest-framework.org/) with an auto-generated, OpenAPI-typed client.
+- 🧵 **Background tasks** — [Celery](https://docs.celeryq.dev/) workers and scheduled jobs, backed by Redis.
+- 🐘 **Postgres** — the standard Django database, ready to go.
+- 🐳 **Docker** — local services (Postgres, Redis) wired up with Docker Compose.
+- 🛠️ **Tooling** — Uv for Python, Vite for front end, Ruff formatting/linting, pre-commit hooks, a test suite, and GitHub Actions CI.
+- 🤖 **Agent-ready** — ships with `CLAUDE.md`/`AGENTS.md` and built-in skills files, so coding agents understand how to work with the codebase out of the box.
+
+## Custom codebase creator
+
+You can create a free, personalized version of this project using the [SaaS Pegasus codebase creator](https://www.saaspegasus.com/projects/)
+(requires signup). This lets you change project details, add/remove features, and change your preferred coding assistant.
+You'll also get one-click upgrades and tools for coding agents to configure your project for you.
+
+Don't need customizations? That's fine too, just fork this project and start coding!
+
+## Open-source edition vs. SaaS Pegasus Pro
+
+This repo is a great way to start hobby/personal Django projects and evaluate SaaS Pegasus.
+The pro version is more suitable for business-grade SaaS and AI applications.
+
+| Feature | This repo | SaaS Pegasus Pro |
+| --- | :---: | :---: |
+| Django + Postgres + Celery foundation | ✅ | ✅ |
+| Authentication (allauth) | ✅ | ✅ |
+| REST API (DRF) | ✅ | ✅ |
+| Tailwind + DaisyUI + vite front end | ✅ | ✅ |
+| Docker & CI | ✅ | ✅ |
+| **Stripe subscriptions & billing** | — | ✅ |
+| **Teams & multi-tenancy** | — | ✅ |
+| **Built-in AI chat/agent app** | — | ✅ |
+| **One-click production deployment** (Render, Fly, Heroku, GCP, AWS…) | — | ✅ |
+| **Social & 2FA login, API keys, user impersonation** | — | ✅ |
+| **Dedicated support & priority fixes** | Community | ✅ |
+
+**[Check out SaaS Pegasus Pro →](https://www.saaspegasus.com/)**
+
+---
 
 ## Quickstart
 
@@ -171,4 +231,23 @@ find . -name '*.py' | entr uv run manage.py test apps.web.tests.test_basic_views
 
 ---
 
-*Built with [SaaS Pegasus](https://www.saaspegasus.com/), the Django SaaS boilerplate.*
+## Documentation
+
+This project is built with [SaaS Pegasus](https://www.saaspegasus.com/), and all relevant parts of the
+[Pegasus documentation](https://docs.saaspegasus.com/) apply here too.
+
+Splitting out the open-source documentation from the pro documentation is still a work in progress.
+
+## Support
+
+This open-source edition is provided as-is, and is supported by the community. Issues and pull
+requests are welcome.
+
+For dedicated support, priority bug fixes, and the full feature set, check out
+[SaaS Pegasus](https://www.saaspegasus.com/).
+There is also a community Slack instance for all Pegasus Pro customers.
+
+## License
+
+This boilerplate is released under the [MIT License](./LICENSE) — free to use for personal and
+commercial projects.