https://github.com/zostera/django-bootstrap5
Bootstrap 5 for Django
https://github.com/zostera/django-bootstrap5
Last synced: 9 months ago
JSON representation
Bootstrap 5 for Django
- Host: GitHub
- URL: https://github.com/zostera/django-bootstrap5
- Owner: zostera
- License: bsd-3-clause
- Created: 2021-03-15T13:32:45.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-12T20:48:45.000Z (9 months ago)
- Last Synced: 2025-05-12T21:43:29.957Z (9 months ago)
- Language: Python
- Size: 1.47 MB
- Stars: 429
- Watchers: 14
- Forks: 87
- Open Issues: 40
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Authors: AUTHORS
Awesome Lists containing this project
README
# django-bootstrap5
[](https://github.com/zostera/django-bootstrap5/actions?workflow=test)
[](https://coveralls.io/github/zostera/django-bootstrap5?branch=main)
[](https://pypi.python.org/pypi/django-bootstrap5)
Bootstrap 5 for Django.
## Goal
The goal of this project is to seamlessly blend Django and Bootstrap 5.
## Status
Ready for production. Issues and pull requests welcome, see [CONTRIBUTING.md](CONTRIBUTING.md).
## Requirements
This package requires a combination of Python and Django that is currently supported.
See "Supported Versions" on https://www.djangoproject.com/download/.
This package uses [uv](https://github.com/astral-sh/uv) and [just](https://github.com/casey/just) for local development.
## Documentation
The full documentation is at https://django-bootstrap5.readthedocs.io/
## Installation
1. Install using pip:
```console
pip install django-bootstrap5
```
2. Add to `INSTALLED_APPS` in your `settings.py`:
```python
INSTALLED_APPS = (
# ...
"django_bootstrap5",
# ...
)
```
3. In your templates, load the `django_bootstrap5` library and use the `bootstrap_*` tags. See example below.
## Example template
```jinja2
{% load django_bootstrap5 %}
{% csrf_token %}
{% bootstrap_form form %}
{% bootstrap_button button_type="submit" content="OK" %}
{% bootstrap_button button_type="reset" content="Cancel" %}
```
## Example app
An example app is provided in the folder `example`. You can run the example app with this command:
```console
just example
```
## Bugs and suggestions
If you have found a bug or if you have a request for additional functionality, please use the issue tracker on GitHub.
https://github.com/zostera/django-bootstrap5/issues
## License
You can use this under BSD-3-Clause. See [LICENSE](LICENSE) file for details.
## Author
Developed and maintained by [Zostera](https://zostera.nl).
Original author: [Dylan Verheul](https://github.com/dyve).
Thanks to everybody that has contributed pull requests, ideas, issues, comments and kind words.
Please see [AUTHORS](AUTHORS) for a list of contributors.