🚀 Quick-Scale

A SaaS starter kit for AI Engineers and Python-first developers using Django

Quick-Scale is designed to help AI Engineers, Data Scientists, and Backend/Cloud developers launch SaaS applications quickly and efficiently.

It is a project generator that provides a ready-to-use Django-based framework with best practices for scalability, authentication, billing, and deployment—so you can focus on building your product, not setting up infrastructure.

👉 Go from idea to paying customers with minimal setup.

Ideal for solo developers or small teams looking to turn their ideas into production-ready SaaS solutions with minimal effort.

GET STARTED 🔥 - LAUNCH QUICKLY 🚀

1. Install: pip install quickscale
2. Create project: quickscale init awesome-project
3. Configure: Review and edit .env file with your settings
4. Start: quickscale up
5. Access: http://localhost:8000

KEY FEATURES

• Complete SaaS Foundation: Authentication, user management, and Stripe billing integration (in progress)
• Ready-to-Use Pages: Landing, dashboard, login, signup, profile, and more
• Modern Frontend: HTMX and Alpine.js for dynamic interactions without complex JavaScript
• Containerized: Docker setup for consistent development and deployment
• Command-Line Control: Intuitive CLI for managing your project lifecycle
• Starter Accounts: Pre-configured user and admin accounts for immediate testing
• Automatic Port Fallback: Smart handling of port conflicts with automatic alternative port selection

PROJECT USAGE

QuickScale provides a convenient command-line interface to manage your projects:

Available commands:
  init           - Initialize a new QuickScale project
  up             - Start the project services
  down           - Stop the project services
  logs           - View project logs (optional service parameter: web, db)
  manage         - Run Django management commands
  check          - Check project status and requirements
  ps             - Show the status of running services
  shell          - Enter an interactive bash shell in the web container
  django-shell   - Enter the Django shell in the web container
  destroy        - Permanently destroy the current project (Warning deletes all code)
  help           - Show this help message
  version        - Show the current version of QuickScale

Examples:

quickscale init awesome-project   # Create a new project called "awesome-project"
quickscale up                     # Start the services
quickscale logs web               # View logs from the web service
quickscale shell                  # Enter an interactive bash shell in the web container
quickscale django-shell           # Enter the Django shell in the web container
quickscale down                   # Stop the services

STARTER PAGES

• Public:
  • Home: Landing page
  • Login: User authentication
  • Register: New user registration
  • Contact: Contact form
  • About: Project information
  • Navigation Bar: Site navigation
• User Private:
  • Dashboard: User dashboard ("My Dashboard")
  • Profile: User profile management
  • Settings: User settings
• Admin Private:
  • Dashboard: Admin dashboard for staff users
  • Profile: Admin profile
  • Settings: System settings
  • Users CRUD: User management

STARTER DATABASE

• User:

  • email: user@test.com
  • password: userpasswd

• Administrator:

  • email: admin@test.com
  • password: adminpasswd

DOCUMENTATION

• User Guide - How to use QuickScale, including setup and deployment instructions
• Technical Documentation - Technical stack, project structure, and development details
• Contributing Guide - How to contribute to QuickScale. Also it is a template for AI codding assistants to generate code for the project. Cursor, Windsurf and GitHub Coplitot rules are linked to this file.
• Roadmap - Future plans and features for QuickScale
• Changelog - Release notes and version history
• HomePage
• Other documentation links:
  • CREDIT_SYSTEM.md Credit System Documentation.
  • DATABASE_VARIABLES.md Database Environment Variables.
  • MESSAGE_MANAGER.md Message Manager Utility.