PunkwebBB is a Django application that provides a simple and modern forum board software for your Django website.
This is the successor to punkweb-boards.
Check out punkweb.net for a live demo and more information!
- Python 3.11+
- Django 4.2+
- django-precise-bbcode 1.2+
- Pillow
It may work with older versions of Python and Django, but it has not been tested.
pip install punkweb-bb
Add precise_bbcode
and punkweb_bb
to your INSTALLED_APPS
in your Django settings module:
INSTALLED_APPS = [
...
"precise_bbcode",
"punkweb_bb",
]
Note: precise_bbcode
is required. It must be installed before punkweb_bb
.
Add the following middleware to your MIDDLEWARE
setting:
MIDDLEWARE = [
...
"punkweb_bb.middleware.ProfileOnlineCacheMiddleware",
]
Add the following context processor to your TEMPLATES
setting:
TEMPLATES = [
{
...
"OPTIONS": {
"context_processors": [
...
"punkweb_bb.context_processors.punkweb_bb",
],
},
},
]
Add the following URL pattern to your urls.py
:
from django.urls import path, include
urlpatterns = [
...
path("forum/", include("punkweb_bb.urls")), # or any other path you want
]
And finally, install the models:
python manage.py migrate
You can configure the following settings in your Django settings module:
PUNKWEB_BB = {
"SITE_NAME": "PUNKWEB",
"SITE_TITLE": "PunkwebBB",
"SHOUTBOX_ENABLED": True,
}
Report:
coverage run && coverage report
HTML:
coverage run && coverage html