Metadata-Version: 2.1
Name: punkweb-bb
Version: 0.1.1
Summary: Django application that provides a simple and modern forum board software for your Django website.
Home-page: https://github.com/Punkweb/PunkwebBB
Author: Punkweb
Author-email: punkwebnet@gmail.com
License: BSD-3-Clause
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: django >=4.0
Requires-Dist: django-precise-bbcode
Requires-Dist: pillow

# PunkwebBB

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](https://github.com/Punkweb/punkweb-boards)

## Built with

- [Django](https://www.djangoproject.com/)
- [django-precise-bbcode](https://github.com/ellmetha/django-precise-bbcode)
- [HTMX](https://htmx.org/)
- [jQuery](https://jquery.com/)
- [SCEditor](https://www.sceditor.com/)
- [PrismJS](https://prismjs.com/)

## Requirements

- 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.

## Testing

Report:

```bash
coverage run && coverage report
```

HTML:

```bash
coverage run && coverage html
```

## Preview

#### Models

![Models](https://github.com/Punkweb/PunkwebBB/blob/main/images/models.png)

#### Index View

![Index](https://github.com/Punkweb/PunkwebBB/blob/main/images/index.png)

#### Thread View

![Thread](https://github.com/Punkweb/PunkwebBB/blob/main/images/thread.png)
