Basic Installation

Basic Installation

This guide will walk you through how to set up a PunkwebBB forum board in a new or existing Django project.

Requirements
- Python 3.9+
- Django 4.0+

It may work with older versions of Python and Django, but so far it's only been tested against these versions!

Installation

The first step will be to install the package.  This guide will assume you're using pip, but should work if you're using poetry or another Python package manager.

pip install punkweb-bb

This will install punkweb-bb and it's dependencies.

Next you will need to add punkweb_bb to your INSTALLED_APPS in your project's settings module.

INSTALLED_APPS = [
    ...
    "punkweb_bb",
]

The final setup step is to include PunkwebBB's URL patterns into your project's urls.py:

from django.urls import path, include

urlpatterns = [
    ...
    path("forum/", include("punkweb_bb.urls")), # or any other path you want
]

After this step, your basic forum board is completely set up, the last thing to do is to run migrations to create the database tables included by PunkwebBB.

python manage.py migrate

---

Verifying setup

python manage.py runserver

Visit http://localhost:8000/forum/ in your browser.  At this point you should see a working forum board that you can begin configuring.  As a superuser, you should be able to add categories and subcategories directly from the forum, or through the Django admin.

Further configuration

That's all for this tutorial, but I'll be creating more guides here to go into how you can include other optional functionality and customize the forum to your liking.  At this point you've set up the very basic out of the box PunkwebBB forum board, but there are tons of optional configurations and customizations you can make!

Obrigado, vou testar e talvez implementar novos comandos e novas funções.