uktrade-intranet-design-system 0.0.1

A Design System for Django used by UKTrade

django-design-system

A Django-native approach to writing front end components that are exposed as templatetags. Comes with an auto-generated, customisable live interactive gallery of your UI components alongside your Django project.

Components are recognisably Django elements; they look and work like Models or Forms. The gallery auto-discovers them, renders live previews in sandboxed iframes, generates templatetag usage examples, and builds a searchable navigation tree — all from your existing code and docstrings.

Quick start

pip install django-design-system

Then follow the quickstart guide to register your first component.

Documentation

Full documentation lives in the docs/ directory and can be browsed locally with:

make docs-serve

Document	Contents
docs/quickstart.md	Installation and first component
docs/components.md	Defining components and parameters
docs/registry.md	Auto-discovery and the component registry
docs/gallery.md	Configuring and customising the gallery
docs/templatetags.md	Using components in templates

Contributing

See CONTRIBUTING.md for how to set up a dev environment, run tests, and submit a pull request.

Issues and feature requests

Please open an issue on GitHub. Use the bug report template for defects and the feature request template for new ideas.

Security

To report a vulnerability privately, see SECURITY.md.

Licence

MIT