duckframework/duck

---

Quickstart

# Install Duck Framework
pip install duckframework

# Create a project
duck makeproject myproject

# Change directory to myproject
cd myproject

# Run the webserver
python web/main.py # Optionally use duck runserver

Visit http://localhost:8000 — you're running Duck. For the full walkthrough (install options, project types, what gets generated), see Getting Started.

---

HTML & Lively Components

Duck includes everything you need to build your UI, while Quirl, the official component library, provides modern, reusable HTML and Lively components for building richer interfaces and interactions.

---

Documentation

New to Duck? Start with Getting Started, then Understanding the Project. You'll have everything you need to build your first app. Explore the other guides as your project grows.

1. Start Here

• Getting Started — install Duck, create a project, and start the server.
• Understanding the Project — understand main.py, urls.py, views, pages, components, templates, and static files.

2. Build with Duck

• Native Apps — get started with Duck Native and native app development.
• Django Integration — add Duck's HTTP/2, HTTPS, and security features to an existing Django project.
• Features — explore Duck's capabilities and planned features.

3. Resources

• AI Guidelines — use Duck with AI assistants and AI-assisted development.
• About & Links — discover real-world apps, useful links, and fun facts.
• Contributing — learn about contributing, reporting issues, sponsorship, and premium components.
• Official Documentation — explore the full documentation.

---

Duck is updated regularly — check the repo for improvements and bug fixes.