message-board
message-board is a simple text posting application built with the Django 4.2.x web framework
Table of Contents
Features
-
Application
- Post simple text messages
- User registration with email verification & social(GitHub) login using django-allauth
- Bootstrap4 & crispy-forms decorations
- Customizable user profile pages with bio, profile pic, & country flags
- For additional links to package resources used in this repository, see the Package Index
-
Dev/testing
- Basic module testing templates
- Coverage reports in
htmlcov
directory - Debug-toolbar available. See notes in
config/settings.py
for enabling. - Examples of using Factories & pytest fixtures in account app testing
- shell_plus with IPython via django-extensions package
- Nox testing sessions for latest Python 3.9, 3.10, 3.11, and 3.12
- black (
nox -s black
) - Sphinx documentaion generation (
nox -s lint
) - linting
- safety(python package vulnerability testing) (
nox -s safety
) - pytest sessions with
pytest-cov &
pytest-django (
coverage run -m pytest
)
- black (
-
run
command menu(adapted from Nick Janetakis' helpful docker-django-example)
You can run
./run
to get a list of commands and each command has documentation in the run file itself. This comes in handy to run various Docker commands because sometimes these commands can be a bit long to type.If you get tired of typing
./run
you can always create a shell alias withalias run=./run
in your~/.bash_aliases
or equivalent file. Then you'll be able to runrun
instead of./run
.
Installation
git clone https://github.com/kevinbowen777/message-board.git
cd message-board
- Local installation:
poetry shell
poetry install
python manage.py migrate
python manage.py createsuperuser
python manage.py runserver
- Docker installation:
docker compose up --build
docker compose exec web python manage.py migrate
docker compose exec web python manage.py createsuperuser
Additional commands:docker compose exec web python manage.py shell_plus
(loads Django shell autoloading project models & classes)docker run -it message-board-web bash
(CLI access to container)
- Browse to http://127.0.0.1:8000 or http://127.0.0.1:8000/resources/
- Pre-commit:
- To add the hook, run the following command in the poetry shell:
pre-commit install
- To add the hook, run the following command in the poetry shell:
Testing
docker compose exec web python manage.py test
coverage run -m pytest
- Nox (includes sessions for black, lint, safety, tests)
- testing supported for Python 3.9, 3.10, 3.11, 3.12
- e.g.
nox
,nox -rs lint-3.11
,nox -s tests
nox
nox -s black-3.12
nox -s docs-3.11
nox -rs lint-3.9
(Use the 'r' flag to reuse existing session)nox -s safety
(will run tests against all Python versions)nox -s tests
Application Demo
TBD
Screenshots
Home
Message Index
Profile Page
Login Page
New Message
Edit Message
Delete Message
Email Address management
Reporting Bugs
Visit the Issues page to view currently open bug reports or open a new issue.