Misc (#228)

* update license

* Add explicit port forward for devcontainer

* fix pyproject error

* Update constitution.json

* Silence useless startup warning

* Add documentation for repository layout

* Update link styles

* Update "about" page

* Update README

* Fix contributing webhook url

* fix the fix

Author: mfosterw

.devcontainer/devcontainer.json

@@ -25,6 +25,9 @@
   // "remoteEnv": {"PATH": "/home/dev-user/.local/bin:${containerEnv:PATH}"},
   "remoteUser": "dev-user",
   "workspaceFolder": "/app",
+  "forwardPorts": [
+    8000 // Github codespaces cant' detect this port automatically for some reason
+  ],
   "features": {
     "ghcr.io/devcontainers/features/docker-outside-of-docker:1": {}
   },

.prettierignore

@@ -127,7 +127,7 @@ To test your webhook, follow these `instructions`_. (If you have a preferred
 tool for exposing your local server, feel free to replace smee with it.) If you
 are using smee, be sure to run::
 
-   $ smee --url WEBHOOK_PROXY_URL --path /webhooks/github --port 8000
+   $ smee --url WEBHOOK_PROXY_URL --path /hooks/github/ --port 8000
 
 to set the correct port and path.
 

CONTRIBUTING.rst

@@ -1,6 +1,5 @@
-
 The MIT License (MIT)
-Copyright (c) 2024, Matthew Foster Walsh
+Copyright (c) 2025, Matthew Foster Walsh
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

LICENSE

@@ -1,13 +1,13 @@
 Democrasite
 ===========
 
-|Built with Cookiecutter Django| |Black code style| |Continuous integration| |Coverage report| |Documentation status|
+|Built with Cookiecutter Django| |Ruff| |Continuous integration| |Coverage report| |Documentation status|
 
 .. |Built with Cookiecutter Django| image:: https://img.shields.io/badge/built%20with-Cookiecutter%20Django-ff69b4.svg?logo=cookiecutter
      :target: https://github.com/pydanny/cookiecutter-django/
 
-.. |Black code style| image:: https://img.shields.io/badge/code%20style-black-000000.svg
-     :target: https://github.com/ambv/black
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: //github.com/astral-sh/ruff
 
 .. |Continuous integration| image:: https://github.com/mfosterw/cookiestocracy/actions/workflows/ci.yml/badge.svg
      :target: https://github.com/mfosterw/cookiestocracy/actions/workflows/ci.yml
@@ -23,8 +23,8 @@ Democrasite
 
 Democrasite is a website which automatically merges changes based on popular
 approval. For more information on the nature and purpose of the project, visit
-our `about page`_. This page is meant for people who want to clone the
-repository and contribute to the project. This project is approximately in beta
+our `about page`_. This page is meant for people who want to fork the
+repository and/or contribute to the project. This project is approximately in beta
 development (hence the repository being named "cookiestocracy" - a reference
 to cookiecutter and `kakistocracy`_). The alpha version is `here`_ and the
 full version doesn't exist yet.
@@ -55,7 +55,7 @@ Getting Started
 The easiest way to explore the repository is to open it in GitHub Codespaces with the
 button above. Once you've given the container some time to set up (it should take about
 three minutes), navigate to the ports tab right above the terminal and hover over port
-3000, then click on the browser icon that appears. You should see the development
+8000, then click on the browser icon that appears. You should see the development
 version of the homepage! (With no data yet, see below).
 
 Please read the `contribution guide`_ to set up a local development environment with
@@ -64,6 +64,20 @@ following the instructions in the guide.
 
 .. _`contribution guide`: https://cookiestocracy.readthedocs.io/en/latest/CONTRIBUTING.html
 
+.. warning::
+    Firefox's "advanced tracking protection" can cause problems connecting to the
+    codespace. If you are experiencing errors, you can disable it for that page by
+    clicking on the shield icon to the left of the URL and switching off Advanced
+    Tracking Protection
+
+
+Understanding the repository
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Check out ``repo_map.txt`` in the root of the repository for a display of the
+repository layout and brief explanations for the purpose of each non-obvious file and
+directory.
+
 
 Management Commands
 -------------------
@@ -80,7 +94,7 @@ Loading initial data
 
 To load some initial sample data into the database, run::
 
-    $ python manage.py loaddata initial.json
+    $ python manage.py loaddata democrasite activitypub
 
 Setting up your users
 ^^^^^^^^^^^^^^^^^^^^^

README.rst

@@ -1,5 +1,6 @@
 """Base settings to build other settings files upon."""
 
+import warnings
 from pathlib import Path
 
 import environ
@@ -36,8 +37,11 @@
 
 # DATABASES
 # ------------------------------------------------------------------------------
+with warnings.catch_warnings():
+    warnings.simplefilter("ignore")  # environ raises an unhelpful warning here
+    db_url = env.db("DATABASE_URL", default=None)
 # https://docs.djangoproject.com/en/dev/ref/settings/#databases
-if db_url := env.db("DATABASE_URL", default=None):
+if db_url:
     DATABASES = {"default": db_url}
 else:
     DATABASES = {

config/settings/base.py

@@ -1,18 +1,13 @@
 {
   "constitution.json": null,
-  "config/settings/base.py": [[340, 359]],
-  "config/urls.py": [[9, 16]],
+  "config/settings/base.py": [[412, 431]],
+  "config/urls.py": [[14, 33]],
   "democrasite/static/js/vote.js": null,
   "democrasite/templates/base.html": null,
-  "democrasite/users/models.py": [[7, 13]],
-  "democrasite/users/urls.py": null,
+  "democrasite/users/models.py": [[19, 35]],
   "democrasite/webiscite/constitution.py": null,
-  "democrasite/webiscite/models.py": [[11, 84]],
-  "democrasite/webiscite/tasks.py": [
-    [43, 80],
-    [89, 96],
-    [112, 176]
-  ],
-  "democrasite/webiscite/urls.py": [[16, 22]],
-  "democrasite/webiscite/views.py": [[110, 133]]
+  "democrasite/webiscite/models.py": [[106, 439]],
+  "democrasite/webiscite/tasks.py": [[23, 78]],
+  "democrasite/webiscite/urls.py": [[10, 16]],
+  "democrasite/webiscite/views.py": [[127, 171]]
 }

constitution.json

@@ -1,5 +1,5 @@
 """
 To understand why this file is here, please read:
 
-http://cookiecutter-django.readthedocs.io/en/latest/faq.html#why-is-there-a-django-contrib-sites-directory-in-cookiecutter-django
+https://cookiecutter-django.readthedocs.io/en/latest/5-help/faq.html#why-is-there-a-django-contrib-sites-directory-in-cookiecutter-django
 """

democrasite/contrib/__init__.py

@@ -1,5 +1,5 @@
 """
 To understand why this file is here, please read:
 
-http://cookiecutter-django.readthedocs.io/en/latest/faq.html#why-is-there-a-django-contrib-sites-directory-in-cookiecutter-django
+https://cookiecutter-django.readthedocs.io/en/latest/5-help/faq.html#why-is-there-a-django-contrib-sites-directory-in-cookiecutter-django
 """

democrasite/contrib/sites/__init__.py

@@ -1,7 +1,7 @@
 """
 To understand why this file is here, please read:
 
-http://cookiecutter-django.readthedocs.io/en/latest/faq.html#why-is-there-a-django-contrib-sites-directory-in-cookiecutter-django
+https://cookiecutter-django.readthedocs.io/en/latest/5-help/faq.html#why-is-there-a-django-contrib-sites-directory-in-cookiecutter-django
 """
 
 from django.conf import settings