# 🚀 QuickScale
<!--
README.md - User-Focused Introduction
PURPOSE: This file serves as the first contact point for users, developers, and evaluators visiting the QuickScale project.
CONTENT GUIDELINES:
- Keep content user-facing and accessible to newcomers
- Focus on "what" and "how to get started" rather than "why" or technical details
- Include quick examples and development workflows
- Avoid deep architectural explanations (those belong in DECISIONS.md)
- Avoid competitive analysis or strategic context (those belong in QUICKSCALE.md)
- Maximum length: ~200 lines to ensure quick readability
- Link to other documents for detailed information
TARGET AUDIENCE: New users, potential adopters, GitHub visitors, developers evaluating QuickScale
-->
---
## QuickScale: Compose your Django SaaS.
QuickScale is a **composable Django framework** for building client SaaS applications. Start with a stable core, add reusable modules, customize themes, and deploy faster—while maintaining the flexibility to create commercial extensions and build a community ecosystem.
---
## What is QuickScale?
QuickScale is a **composable Django framework** designed for **solo developers and development agencies** who build multiple client SaaS applications. It provides a stable foundation with reusable components, enabling you to:
- **Build once, reuse everywhere**: Create modules and themes that work across all your client projects
- **Maintain commercial flexibility**: Keep core components open source while offering premium modules/themes via subscriptions
- **Scale your development business**: Standardize your tech stack and accelerate client project delivery
- **Build a community ecosystem**: Share and monetize your extensions while benefiting from community contributions
🧭 **Evolution Snapshot**: QuickScale intentionally ships as a personal toolkit today and only grows into a community platform when real demand emerges. Catch the full story in the [evolution overview](./docs/overview/quickscale.md#evolution-strategy-personal-toolkit-first).
## Documentation Guide
**Start here for your needs:**
- 📖 **New user?** You're in the right place. This README shows you what QuickScale is and how to get started.
- 🔧 **Need commands?** See [user_manual.md](./docs/technical/user_manual.md) for all commands and workflows
- 🚀 **Deploying to Railway?** See [railway.md](./docs/deployment/railway.md) for Railway deployment guide
- 📋 **Planning a feature?** Check [decisions.md](./docs/technical/decisions.md) for the authoritative MVP scope and technical rules
- 🗓️ **Timeline & tasks?** See [roadmap.md](./docs/technical/roadmap.md)
- 🏗️ **Project structure?** See [scaffolding.md](./docs/technical/scaffolding.md) for complete directory layouts
- 🎯 **Why QuickScale?** See [quickscale.md](./docs/overview/quickscale.md) for competitive positioning
**Quick Reference:**
- **MVP** = Phase 1 (Personal Toolkit)
- **Post-MVP** = Phase 2+ (Modules & Themes)
- **Generated Project** = Output of `quickscale init`
See [decisions.md - Glossary section](./docs/technical/decisions.md#document-responsibilities-short) for complete terminology and Single Source of Truth reference
### Primary Use Cases:
- **Solo Developer**: Build client projects faster with reusable components you maintain
- **Development Agency**: Standardize your tech stack across multiple client engagements
- **Commercial Extension Developer**: Create and sell premium modules/themes
- **Open Source Contributor**: Extend the ecosystem with new modules and themes
### Development Flow (MVP)
1. `quickscale init myapp`
- Generates the minimal Django starter described in the MVP Feature Matrix
- Ships with standalone `settings.py` by default; there is NO automatic settings inheritance. Advanced users who manually embed `quickscale_core` via git subtree may opt-in to inherit from `quickscale_core.settings` (see [decisions.md](./docs/technical/decisions.md#mvp-feature-matrix-authoritative)).
- **Optional**: Embed `quickscale_core` via git subtree after generation; follow the [Personal Toolkit workflow](./docs/technical/decisions.md#integration-note-personal-toolkit-git-subtree) for canonical commands and helper roadmap
2. Add your custom Django apps and features
3. Adopt optional inheritance or module extraction patterns only when you embed the core; the rules and best practices stay centralized in `DECISIONS.md`
4. Build your unique client application
5. Deploy using standard Django deployment patterns
ℹ️ QuickScale's MVP centers on the personal toolkit workflow. Extraction patterns, module packaging, and subtree helper command plans stay documented in `docs/technical/decisions.md` so this README can stay concise.
🔎 **Scope note**: The [MVP Feature Matrix](./docs/technical/decisions.md#mvp-feature-matrix-authoritative) is the single source of truth for what's in or out.
### What You Get
Running `quickscale init myapp` generates a **production-ready Django project** with:
- ✅ **Docker** setup (development + production)
- ✅ **PostgreSQL** configuration
- ✅ **Environment-based** settings (dev/prod split)
- ✅ **Security** best practices (SECRET_KEY, ALLOWED_HOSTS, etc.)
- ✅ **Testing** infrastructure (pytest + factory_boy)
- ✅ **CI/CD** pipeline (GitHub Actions)
- ✅ **Code quality** hooks (ruff format + ruff check)
- ✅ **Poetry** for dependency management
**See the complete project structure:** [scaffolding.md - Generated Project Output](./docs/technical/scaffolding.md#5-generated-project-output)
The generated project is **yours to own and modify** - no vendor lock-in, just Django best practices.
## Why QuickScale?
✅ **Production-ready from day one** - Docker, PostgreSQL, pytest, CI/CD, security best practices
✅ **Built on Django** - No magic, just excellent Django patterns and battle-tested packages
✅ **Shared improvements** - Security fixes and updates flow across all your projects via git subtree
✅ **Full ownership** - Generated projects are 100% yours, no vendor lock-in
**QuickScale is a development accelerator**, not a complete solution. You start with production-ready foundations and build your unique client application on top.
See [competitive_analysis.md](./docs/overview/competitive_analysis.md) for detailed comparison with SaaS Pegasus and Cookiecutter.
---
## Quick Start
```bash
# Install QuickScale globally
./scripts/install_global.sh
# Create your first project
quickscale init myapp
# Start developing
cd myapp
poetry install
poetry run python manage.py migrate
poetry run python manage.py runserver
```
**That's it!** Visit http://localhost:8000 to see your new Django project.
### Development Workflow with Docker
QuickScale includes convenient CLI commands for Docker-based development:
```bash
# Start all services (web + database)
quickscale up
# View logs
quickscale logs -f web
# Run Django commands
quickscale manage migrate
quickscale manage createsuperuser
# Open a shell in the container
quickscale shell
# Stop services
quickscale down
```
**For complete command reference and workflows**, see the [user_manual.md](./docs/technical/user_manual.md).
## Learn More
- **[decisions.md](./docs/technical/decisions.md)** - Technical specifications and implementation rules
- **[quickscale.md](./docs/overview/quickscale.md)** - Strategic vision and competitive positioning
- **[competitive_analysis.md](./docs/overview/competitive_analysis.md)** - Comparison vs SaaS Pegasus and alternatives
- **[roadmap.md](./docs/technical/roadmap.md)** - Development roadmap and implementation plan
- **[user_manual.md](./docs/technical/user_manual.md)** - Commands and workflows
- **[contributing.md](./docs/contrib/contributing.md)** - Development workflow and coding standards
Raw data
{
"_id": null,
"home_page": "https://github.com/Experto-AI/quickscale",
"name": "quickscale-core",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "django, scaffolding, project-generator, saas",
"author": "Experto AI",
"author_email": "victor@experto.ai",
"download_url": "https://files.pythonhosted.org/packages/57/68/9683086881f2d2639bde5c3acbe05768c1507eadd145f8ae95c4ab12a4e8/quickscale_core-0.59.0.tar.gz",
"platform": null,
"description": "# \ud83d\ude80 QuickScale\n\n<!-- \nREADME.md - User-Focused Introduction\n\nPURPOSE: This file serves as the first contact point for users, developers, and evaluators visiting the QuickScale project.\n\nCONTENT GUIDELINES:\n- Keep content user-facing and accessible to newcomers\n- Focus on \"what\" and \"how to get started\" rather than \"why\" or technical details \n- Include quick examples and development workflows\n- Avoid deep architectural explanations (those belong in DECISIONS.md)\n- Avoid competitive analysis or strategic context (those belong in QUICKSCALE.md)\n- Maximum length: ~200 lines to ensure quick readability\n- Link to other documents for detailed information\n\nTARGET AUDIENCE: New users, potential adopters, GitHub visitors, developers evaluating QuickScale\n-->\n\n---\n\n## QuickScale: Compose your Django SaaS.\n\nQuickScale is a **composable Django framework** for building client SaaS applications. Start with a stable core, add reusable modules, customize themes, and deploy faster\u2014while maintaining the flexibility to create commercial extensions and build a community ecosystem.\n\n---\n\n## What is QuickScale?\n\nQuickScale is a **composable Django framework** designed for **solo developers and development agencies** who build multiple client SaaS applications. It provides a stable foundation with reusable components, enabling you to:\n\n- **Build once, reuse everywhere**: Create modules and themes that work across all your client projects\n- **Maintain commercial flexibility**: Keep core components open source while offering premium modules/themes via subscriptions\n- **Scale your development business**: Standardize your tech stack and accelerate client project delivery\n- **Build a community ecosystem**: Share and monetize your extensions while benefiting from community contributions\n\n\ud83e\udded **Evolution Snapshot**: QuickScale intentionally ships as a personal toolkit today and only grows into a community platform when real demand emerges. Catch the full story in the [evolution overview](./docs/overview/quickscale.md#evolution-strategy-personal-toolkit-first).\n\n## Documentation Guide\n\n**Start here for your needs:**\n- \ud83d\udcd6 **New user?** You're in the right place. This README shows you what QuickScale is and how to get started.\n- \ud83d\udd27 **Need commands?** See [user_manual.md](./docs/technical/user_manual.md) for all commands and workflows\n- \ud83d\ude80 **Deploying to Railway?** See [railway.md](./docs/deployment/railway.md) for Railway deployment guide\n- \ud83d\udccb **Planning a feature?** Check [decisions.md](./docs/technical/decisions.md) for the authoritative MVP scope and technical rules\n- \ud83d\uddd3\ufe0f **Timeline & tasks?** See [roadmap.md](./docs/technical/roadmap.md)\n- \ud83c\udfd7\ufe0f **Project structure?** See [scaffolding.md](./docs/technical/scaffolding.md) for complete directory layouts\n- \ud83c\udfaf **Why QuickScale?** See [quickscale.md](./docs/overview/quickscale.md) for competitive positioning\n\n**Quick Reference:**\n- **MVP** = Phase 1 (Personal Toolkit)\n- **Post-MVP** = Phase 2+ (Modules & Themes)\n- **Generated Project** = Output of `quickscale init`\n\nSee [decisions.md - Glossary section](./docs/technical/decisions.md#document-responsibilities-short) for complete terminology and Single Source of Truth reference\n\n\n### Primary Use Cases:\n- **Solo Developer**: Build client projects faster with reusable components you maintain\n- **Development Agency**: Standardize your tech stack across multiple client engagements \n- **Commercial Extension Developer**: Create and sell premium modules/themes\n- **Open Source Contributor**: Extend the ecosystem with new modules and themes\n\n### Development Flow (MVP)\n1. `quickscale init myapp`\n - Generates the minimal Django starter described in the MVP Feature Matrix\n - Ships with standalone `settings.py` by default; there is NO automatic settings inheritance. Advanced users who manually embed `quickscale_core` via git subtree may opt-in to inherit from `quickscale_core.settings` (see [decisions.md](./docs/technical/decisions.md#mvp-feature-matrix-authoritative)).\n - **Optional**: Embed `quickscale_core` via git subtree after generation; follow the [Personal Toolkit workflow](./docs/technical/decisions.md#integration-note-personal-toolkit-git-subtree) for canonical commands and helper roadmap\n2. Add your custom Django apps and features\n3. Adopt optional inheritance or module extraction patterns only when you embed the core; the rules and best practices stay centralized in `DECISIONS.md`\n4. Build your unique client application\n5. Deploy using standard Django deployment patterns\n\n\u2139\ufe0f QuickScale's MVP centers on the personal toolkit workflow. Extraction patterns, module packaging, and subtree helper command plans stay documented in `docs/technical/decisions.md` so this README can stay concise.\n\n\ud83d\udd0e **Scope note**: The [MVP Feature Matrix](./docs/technical/decisions.md#mvp-feature-matrix-authoritative) is the single source of truth for what's in or out.\n\n### What You Get\n\nRunning `quickscale init myapp` generates a **production-ready Django project** with:\n\n- \u2705 **Docker** setup (development + production)\n- \u2705 **PostgreSQL** configuration\n- \u2705 **Environment-based** settings (dev/prod split)\n- \u2705 **Security** best practices (SECRET_KEY, ALLOWED_HOSTS, etc.)\n- \u2705 **Testing** infrastructure (pytest + factory_boy)\n- \u2705 **CI/CD** pipeline (GitHub Actions)\n- \u2705 **Code quality** hooks (ruff format + ruff check)\n- \u2705 **Poetry** for dependency management\n\n**See the complete project structure:** [scaffolding.md - Generated Project Output](./docs/technical/scaffolding.md#5-generated-project-output)\n\nThe generated project is **yours to own and modify** - no vendor lock-in, just Django best practices.\n\n## Why QuickScale?\n\n\u2705 **Production-ready from day one** - Docker, PostgreSQL, pytest, CI/CD, security best practices\n\u2705 **Built on Django** - No magic, just excellent Django patterns and battle-tested packages\n\u2705 **Shared improvements** - Security fixes and updates flow across all your projects via git subtree\n\u2705 **Full ownership** - Generated projects are 100% yours, no vendor lock-in\n\n**QuickScale is a development accelerator**, not a complete solution. You start with production-ready foundations and build your unique client application on top.\n\nSee [competitive_analysis.md](./docs/overview/competitive_analysis.md) for detailed comparison with SaaS Pegasus and Cookiecutter.\n\n---\n\n\n## Quick Start\n\n```bash\n# Install QuickScale globally\n./scripts/install_global.sh\n\n# Create your first project\nquickscale init myapp\n\n# Start developing\ncd myapp\npoetry install\npoetry run python manage.py migrate\npoetry run python manage.py runserver\n```\n\n**That's it!** Visit http://localhost:8000 to see your new Django project.\n\n### Development Workflow with Docker\n\nQuickScale includes convenient CLI commands for Docker-based development:\n\n```bash\n# Start all services (web + database)\nquickscale up\n\n# View logs\nquickscale logs -f web\n\n# Run Django commands\nquickscale manage migrate\nquickscale manage createsuperuser\n\n# Open a shell in the container\nquickscale shell\n\n# Stop services\nquickscale down\n```\n\n**For complete command reference and workflows**, see the [user_manual.md](./docs/technical/user_manual.md).\n\n## Learn More\n\n- **[decisions.md](./docs/technical/decisions.md)** - Technical specifications and implementation rules\n- **[quickscale.md](./docs/overview/quickscale.md)** - Strategic vision and competitive positioning\n- **[competitive_analysis.md](./docs/overview/competitive_analysis.md)** - Comparison vs SaaS Pegasus and alternatives\n- **[roadmap.md](./docs/technical/roadmap.md)** - Development roadmap and implementation plan\n- **[user_manual.md](./docs/technical/user_manual.md)** - Commands and workflows\n- **[contributing.md](./docs/contrib/contributing.md)** - Development workflow and coding standards\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Core scaffolding and utilities for QuickScale Django project generator",
"version": "0.59.0",
"project_urls": {
"Documentation": "https://github.com/Experto-AI/quickscale/tree/main/docs",
"Homepage": "https://github.com/Experto-AI/quickscale",
"Repository": "https://github.com/Experto-AI/quickscale"
},
"split_keywords": [
"django",
" scaffolding",
" project-generator",
" saas"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "97934ab114230f74b83cc764bd0dceea15d64c259b69311e09d4ca896b74f8d5",
"md5": "0178ebd7d79544362413fd30cb32c63a",
"sha256": "154dd791d56bdaef6fa5fb69bdec907ca0344aa060e5666f4fdb40c2eabefeec"
},
"downloads": -1,
"filename": "quickscale_core-0.59.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0178ebd7d79544362413fd30cb32c63a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 54693,
"upload_time": "2025-10-18T20:40:23",
"upload_time_iso_8601": "2025-10-18T20:40:23.333157Z",
"url": "https://files.pythonhosted.org/packages/97/93/4ab114230f74b83cc764bd0dceea15d64c259b69311e09d4ca896b74f8d5/quickscale_core-0.59.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "57689683086881f2d2639bde5c3acbe05768c1507eadd145f8ae95c4ab12a4e8",
"md5": "c4a7ba040f7cebba5de7cef82cfeb9c5",
"sha256": "a4b5ba05bd396042b008c5796d825c75dbf21c60eea990be876d2b9b5e129016"
},
"downloads": -1,
"filename": "quickscale_core-0.59.0.tar.gz",
"has_sig": false,
"md5_digest": "c4a7ba040f7cebba5de7cef82cfeb9c5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 48315,
"upload_time": "2025-10-18T20:40:24",
"upload_time_iso_8601": "2025-10-18T20:40:24.502584Z",
"url": "https://files.pythonhosted.org/packages/57/68/9683086881f2d2639bde5c3acbe05768c1507eadd145f8ae95c4ab12a4e8/quickscale_core-0.59.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-18 20:40:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Experto-AI",
"github_project": "quickscale",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "quickscale-core"
}
JSON
