deep

A htmx and django personal project with the goals of:

• learning more about each with new challenges
• how to write less code but more reusable code
• just trying things out (django-cookiecutter, django-treebeard etc)

This project currently manages nested unordered (informally ordered, I guess) lists of text entries:

• edit an entry (ctrl-click)
• add a sibling (+)
• add a child (/)
• delete self (x)

Immediate goals:

• additional methods on each element (show help string from obj.doc for example)
• use content types to make the content item generic
• page and sub-page objects
• user-awareness and per object group-permissions
• django-ninja api setup

License: MIT

Settings

Moved to settings.

Basic Commands

Setting Up Your Users

• To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

• To create a superuser account, use this command:

  $ python manage.py createsuperuser
  

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

Running type checks with mypy:

$ mypy deep4

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with pytest

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Deployment

The following details how to deploy this application.