bm2 is a public iteration of my personal bookmarks site.
This project exists primarily for two reasons:
- I use it, deployed to bm2.brntn.me, to bookmark sites and manage those bookmarks
- As a playground for me to experiment with techniques, tools and practices
There's are many examples of the former. I was a long-time Pinboard user, and a del.icio.us user before that. For the later, this codebase hits a bunch of things I like:
- Uses the steps in my "Six things I do every time I start a Django project" post (automated with my poorly-documented
djbsscript) - Runs the "Open source Python CI pipeline" in Github Actions (and runs most of the checks locally with pre-commit)
- Takes a testing approach that relies heavily on integration tests ran with the Django test runner
- The majority of new code is added with Test Driven Development and a trunk-based workflow
- Uses my django-middleware and django-authuser projects
- Deploys with Django Up onto a VPS
- Takes a HTML-first approach with no Javascript
- Gets an A+ on Security Headers and the SSL Labs Report (June 2023)
- Commits are GPG signed and (mostly) use Conventional Commits
- Logins require TOTP as a second factor (an extension to my authuser model I'm experimenting with)
I generally use pipenv for Python/Django projects because it's familiar.
You can adopt the usage instructions below to a different tool if that's more your jam.
Getting this running locally is pretty straight forward.
Install the dependencies:
pipenv install
Generate a secure Django secret key and add it to .env:
echo "DJANGO_SECRET_KEY=<secret!>" > .env
Run the initial migrations to setup the database:
pipenv run python manage.py migrate
There's currently no way to create an account through the web interface, so use the CLI to create a user:
pipenv run python manage.py createsuperuser
Running the development server:
pipenv run python manage.py runserver
pipenv run python manage.py test
Notes:
- Ansible must be installed on your local machine
- Target should be running Ubuntu 22.04
- The domain that you are deploying to must be in
ALLOWED_HOSTS
pipenv run python manage.py up <your-domain> --email=<your-email>
A pre-commit configuration is available that runs the same checks as the Github Actions pipeline.
pre-commit install
There checks can be manually run with:
pre-commit run --all-files
Generated with sesh/djbs.