django-basecoat 0.2.0

Ready-made Basecoat components (shadcn/ui) for Django, powered by django-cotton

django-basecoat

Ready-made Basecoat components (shadcn/ui) for Django, powered by django-cotton.

Installation

uv add django-cotton django-basecoat

Add django_basecoat and django_cotton to your INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    "django_cotton",
    "django_basecoat",
    ...
]

Quick Start

Include the required CSS and JS in your base template (or use your own setup):

<script src="https://cdn.jsdelivr.net/npm/@tailwindcss/browser@4"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/basecoat-css@0.3.6/dist/basecoat.cdn.min.css">
<script src="https://cdn.jsdelivr.net/npm/basecoat-css@0.3.6/dist/js/all.min.js" defer></script>

Use components in your templates:

<c-button>Click me</c-button>
<c-card>
    <c-card.header>Card Title</c-card.header>
    <c-card.section>Card content goes here</c-card.section>
</c-card>

Available components include: accordion, alert, avatar, badge, breadcrumb, button, card, checkbox, dialog, dropdown menu, input, select, table, tabs, and more.

Documentation

• Setup Guide - Initial project configuration
• Development Workflow - How to contribute and work with the project

Demo Project

Want to see django-basecoat in action? Check out the demo_project directory for a complete Django application showcasing all available components.

To run the demo:

cd demo_project
./quickstart.sh
# or: make setup && make run

Then visit http://127.0.0.1:8000/ to see the component library in action!