2 | {% include "header/header_link.html" with link="" text="Team" %}
3 | {% include "header/header_link.html" with link="" text="Products" %}
4 | {% include "header/header_link.html" with link="" text="Calendar" %}
5 |
6 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/account/password_reset_from_key_done.html:
--------------------------------------------------------------------------------
1 | {% extends "account/account_base.html" %}
2 | {% block account_title %}
3 | {% translate "Change Password" %}
4 | {% endblock account_title %}
5 | {% block account_content %}
6 |
3 | {{ errors }}
4 | {% csrf_token %}
5 | {% for field, errors in fields %}
6 | {% component "field" field=field / %}
7 | {% endfor %}
8 |
9 | {% for field in hidden_fields %}
10 | {% component "field" field=field / %}
11 | {% endfor %}
12 |
13 |
14 | {% endprovide %}
15 |
--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | # EditorConfig helps developers define and maintain consistent
2 | # coding styles between different editors and IDEs
3 | # editorconfig.org
4 |
5 | root = true
6 |
7 |
8 | [*]
9 | end_of_line = lf
10 | charset = utf-8
11 | trim_trailing_whitespace = true
12 | insert_final_newline = true
13 | indent_style = space
14 | indent_size = 4
15 |
16 | [*.{js,html,css,yml,xml,scss,json}]
17 | indent_style = space
18 | indent_size = 2
19 |
20 | [*.md]
21 | trim_trailing_whitespace = false
22 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/header/logo.html:
--------------------------------------------------------------------------------
1 | "]
6 |
7 | [tool.poetry.dependencies]
8 | python = "^3.11"
9 |
10 | [tool.poetry.group.dev.dependencies]
11 | isort = "^5.13.2"
12 |
13 | [tool.poetry.group.docs.dependencies]
14 | Sphinx = "^8.1.3"
15 | furo = "^2024.7.18"
16 |
17 | [build-system]
18 | requires = ["poetry-core>=1.0.0"]
19 | build-backend = "poetry.core.masonry.api"
20 |
--------------------------------------------------------------------------------
/template/.editorconfig:
--------------------------------------------------------------------------------
1 | # EditorConfig helps developers define and maintain consistent
2 | # coding styles between different editors and IDEs
3 | # editorconfig.org
4 |
5 | root = true
6 |
7 |
8 | [*]
9 | end_of_line = lf
10 | charset = utf-8
11 | trim_trailing_whitespace = true
12 | insert_final_newline = true
13 | indent_style = space
14 | indent_size = 4
15 |
16 | [*.{js,html,css,yml,xml,scss,json,ts,jinja}]
17 | indent_style = space
18 | indent_size = 2
19 |
20 | [*.md]
21 | trim_trailing_whitespace = false
22 |
--------------------------------------------------------------------------------
/template/[[project_name]]/static_source/css/base/_typography.scss:
--------------------------------------------------------------------------------
1 | @layer base {
2 | h1 {
3 | @apply text-4xl font-bold mb-3;
4 | }
5 |
6 | h2 {
7 | @apply text-3xl font-bold mb-2;
8 | }
9 |
10 |
11 | h3 {
12 | @apply text-3xl font-semibold mb-2;
13 | }
14 |
15 | h4 {
16 | @apply text-2xl font-semibold mb-1;
17 | }
18 |
19 | h5 {
20 | @apply text-xl mb-1;
21 | }
22 |
23 | h6 {
24 | @apply text-lg;
25 | }
26 |
27 | ul {
28 | @apply list-disc list-inside;
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/404.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 | {% block title %}
3 | {% translate "Page not found" %}
4 | {% endblock title %}
5 | {% block content %}
6 |
7 |
8 |
{% translate "Page not found" %}
9 |
{% translate "This is not the page you were looking for." %}
10 |
11 | {% if exception %}{{ exception }}{% endif %}
12 |
13 |
14 |
2 |
3 | {% component "label" field=field %}
4 | {{ field.label }}
5 | {% endcomponent %}
6 |
7 | {% component "widget" field=field / %}
8 | {% if field.help_text %}
9 | {{ field.help_text|safe }}
11 | {% endif %}
12 | {% if field.errors %}{{ field.errors }}
{% endif %}
13 |
14 |
--------------------------------------------------------------------------------
/template/[[project_name]]/config/settings/build.py:
--------------------------------------------------------------------------------
1 | # required settings for build command like collectstatic
2 | import os
3 |
4 | REQUIRED_KEYS = [
5 | "SECRET_KEY",
6 | "DATABASE_URL",
7 | "DJANGO_ALLOWED_HOSTS",
8 | "REDIS_URL",
9 | "AWS_ACCESS_KEY_ID",
10 | "AWS_SECRET_ACCESS_KEY",
11 | "BUCKET_NAME",
12 | "AWS_ENDPOINT_URL_S3",
13 | ]
14 | for key in REQUIRED_KEYS:
15 | os.environ[key] = "dummy"
16 | os.environ["SENTRY_DSN"] = "https://dummy@dummy.ingest.sentry.io/1234567"
17 |
18 | from .prod import *
19 |
--------------------------------------------------------------------------------
/template/[[project_name]]/config/websocket.py:
--------------------------------------------------------------------------------
1 | async def websocket_application(scope, receive, send):
2 | # pylint: disable=unused-argument
3 | while True:
4 | event = await receive()
5 |
6 | if event["type"] == "websocket.connect":
7 | await send({"type": "websocket.accept"})
8 |
9 | if event["type"] == "websocket.disconnect":
10 | break
11 |
12 | if event["type"] == "websocket.receive":
13 | if event["text"] == "ping":
14 | await send({"type": "websocket.send", "text": "pong!"})
15 |
--------------------------------------------------------------------------------
/template/scripts/pull_remote_db.sh.jinja:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 |
4 | export ENV_NAME="[[project_name]]"
5 |
6 | dropdb $ENV_NAME
7 | heroku pg:pull DATABASE_URL $ENV_NAME --app $ENV_NAME-development
8 | for tbl in `psql -qAt -c "select tablename from pg_tables where schemaname = 'public';" $ENV_NAME` ; do psql -c "alter table \"$tbl\" owner to $ENV_NAME" $ENV_NAME ; done
9 | for tbl in `psql -qAt -c "select sequence_name from information_schema.sequences where sequence_schema = 'public';" $ENV_NAME` ; do psql -c "alter table \"$tbl\" owner to $ENV_NAME" $ENV_NAME ; done
10 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/400.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 | {% block title %}
3 | {% translate "Bad Request (400)" %}
4 | {% endblock title %}
5 | {% block content %}
6 |
7 |
8 |
{% translate "Bad Request (400)" %}
9 |
10 | {% if exception %}
11 | {{ exception }}
12 | {% else %}
13 | {% translate "This request was a bad, bad request." %}
14 | {% endif %}
15 |
16 |
17 |
7 |
8 |
{% translate "Forbidden (403)" %}
9 |
10 | {% if exception %}
11 | {{ exception }}
12 | {% else %}
13 | {% translate "You're not allowed to access this page." %}
14 | {% endif %}
15 |
16 |
17 |
3 | {% if is_htmx %}
4 |
13 | {% else %}
14 |
15 | {% slot "content" default required %}
16 | {% endslot %}
17 |
18 | {% endif %}
19 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/home/form_test.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 | {% block title %}
3 | Form Test
4 | {% endblock title %}
5 | {% block content %}
6 |
7 |
Form Field Test
8 |
16 |
6 | {% for group_name, group_choices, group_index in widget.optgroups %}
7 | {% if group_name %}{% endif %}
8 | {% for option in group_choices %}
9 | {% include option.template_name with widget=option %}
10 | {% endfor %}
11 | {% if group_name %} {% endif %}
12 | {% endfor %}
13 |
14 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/500.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 | {% block title %}
3 | {% translate "Server Error" %}
4 | {% endblock title %}
5 | {% block content %}
6 |
7 |
8 |
{% translate "Ooops!!! 500" %}
9 |
{% translate "Looks like something went wrong!" %}
10 |
11 | {% translate "We track these errors automatically, but if the problem persists feel free to contact us. In the meantime, try refreshing." %}
12 |
13 |
14 |
2 |
3 |
4 |
5 |
6 | {% include "header/mobile_menu_button.html" %}
7 | {% include "header/logo.html" %}
8 | {% include "header/desktop_center.html" %}
9 |
10 |
{% include "header/end.html" %}
11 |
12 |
15 |
16 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/form/widgets/input.html:
--------------------------------------------------------------------------------
1 | {% load replace %}
2 |
2 |
6 | Facebook
7 |
11 |
12 |
--------------------------------------------------------------------------------
/template/[[project_name]]/util/util.py:
--------------------------------------------------------------------------------
1 | import datetime
2 | import re
3 | import time
4 |
5 | from django.utils.deconstruct import deconstructible
6 |
7 |
8 | @deconstructible
9 | class file_url: # NOQA
10 | path = "uploads/{0}/{1.year:04}/{1.month:02}/{1.day:02}/{2}/{3}" # NOQA
11 |
12 | def __init__(self, category):
13 | self.category = category
14 |
15 | def __call__(self, instance, filename):
16 | r = re.compile(r"[^\S]")
17 | filename = r.sub("", filename)
18 | now = datetime.datetime.now()
19 | timestamp = int(time.time())
20 | return self.path.format(self.category, now, timestamp, filename)
21 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/form/checkbox.html:
--------------------------------------------------------------------------------
1 |
2 |
{% component "widget" field=field / %}
3 |
4 | {% if field.label %}
5 | {% component "checkbox_label" field=field %}
6 | {{ field.label }}
7 | {% endcomponent %}
8 | {% endif %}
9 | {% if field.help_text %}
10 |
{{ field.help_text|safe }}
12 | {% endif %}
13 | {% if field.errors %}
{{ field.errors }}
{% endif %}
14 |
15 |
2 |
3 | {% slot "trigger" %}
4 | {% component "button" %}
5 | open menu
6 | {% endcomponent %}
7 | {% endslot %}
8 |
9 |
13 | {% slot "content" %}
14 | Content goes here
15 | {% endslot %}
16 |
17 |
3 |
7 | Alpine
8 |
9 |
14 |
15 |
16 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/admin/base_site.html.jinja:
--------------------------------------------------------------------------------
1 | {% extends "admin/base_site.html" %}
2 | {% load django_vite %}
3 | {% block extrahead %}
4 | {{ block.super }}
5 | {% vite_hmr_client %}
6 |
7 | {% endblock extrahead %}
8 | {% block title %}
9 | {% if subtitle %}{{ subtitle }} |{% endif %}
10 | {{ title }} | {{ site_title|default:_("[[project_name_verbose]] site admin") }}
11 | {% endblock title %}
12 | {% block branding %}
13 |
16 | {% endblock branding %}
17 |
--------------------------------------------------------------------------------
/template/[[project_name]]/user/views.py:
--------------------------------------------------------------------------------
1 | from django.contrib.auth.mixins import LoginRequiredMixin
2 | from django.views.generic import RedirectView
3 | from django_htmx.http import HttpResponseClientRedirect
4 |
5 |
6 | class UserRedirectView(LoginRequiredMixin, RedirectView):
7 | permanent = False
8 |
9 | def get(self, request, *args, **kwargs):
10 | url = self.get_redirect_url(*args, **kwargs)
11 | if request.htmx:
12 | return HttpResponseClientRedirect(url)
13 | return super().get(request, *args, **kwargs)
14 |
15 | def get_redirect_url(self, *args, **kwargs):
16 | return "/"
17 |
18 |
19 | user_redirect_view = UserRedirectView.as_view()
20 |
--------------------------------------------------------------------------------
/template/tsconfig.json.jinja:
--------------------------------------------------------------------------------
1 | {
2 | "compilerOptions": {
3 | "types": ["vite/client"],
4 | "target": "es6",
5 | "useDefineForClassFields": true,
6 | "module": "esnext",
7 | "moduleResolution": "bundler",
8 | "strict": true,
9 | "jsx": "preserve",
10 | "sourceMap": true,
11 | "resolveJsonModule": true,
12 | "esModuleInterop": true,
13 | "skipLibCheck": true,
14 | "lib": ["esnext", "dom"]
15 | },
16 | "include": [
17 | "[[project_name]]/**/*.ts",
18 | "[[project_name]]/**/*.d.ts",
19 | "[[project_name]]/**/*.tsx",
20 | "[[project_name]]/**/*.vue",
21 | "[[project_name]]/**/*.js",
22 | "./*.js",
23 | "./*.ts"
24 | ]
25 | }
26 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/footer/footer.py:
--------------------------------------------------------------------------------
1 | from django_components import Component, register
2 |
3 |
4 | @register("footer_nav_link")
5 | class FooterNavLink(Component):
6 | template_name = "footer_nav_link.html"
7 |
8 | def get_context_data(self, href, text):
9 | return {"href": href, "text": text}
10 |
11 |
12 | @register("social_link")
13 | class SocialLink(Component):
14 | template_name = "social_link.html"
15 |
16 | def get_context_data(self, name, href="#", icon_type=None, size="5"):
17 | return {
18 | "href": href,
19 | "name": name,
20 | "icon_type": icon_type or name.lower(),
21 | "size": size,
22 | }
23 |
--------------------------------------------------------------------------------
/docs/Makefile:
--------------------------------------------------------------------------------
1 | # Minimal makefile for Sphinx documentation
2 | #
3 |
4 | # You can set these variables from the command line, and also
5 | # from the environment for the first two.
6 | SPHINXOPTS ?=
7 | SPHINXBUILD ?= sphinx-build
8 | SOURCEDIR = source
9 | BUILDDIR = build
10 |
11 | # Put it first so that "make" without argument is like "make help".
12 | help:
13 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14 |
15 | .PHONY: help Makefile
16 |
17 | # Catch-all target: route all unknown targets to Sphinx using the new
18 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19 | %: Makefile
20 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
21 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/form/widgets/textarea.html:
--------------------------------------------------------------------------------
1 | {% load replace %}
2 |
7 |
13 |
14 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/svg/twitter.svg:
--------------------------------------------------------------------------------
1 |
2 |
6 | Twitter
7 |
9 |
10 |
--------------------------------------------------------------------------------
/template/[[project_name]]/static_source/css/base/_fonts.scss:
--------------------------------------------------------------------------------
1 | // Example font family inclusion
2 | // @font-face {
3 | // font-family: "GT Walsheim Pro";
4 | // src: url("/static/fonts/GT-Walsheim-Pro-Regular.otf") format("opentype");
5 | // font-weight: 400;
6 | // font-style: normal;
7 | // }
8 |
9 | // @font-face {
10 | // font-family: "GT Walsheim Pro";
11 | // src: url("/static/fonts/GT-Walsheim-Pro-Medium.otf") format("opentype");
12 | // font-weight: 500;
13 | // font-style: normal;
14 | // }
15 |
16 | // @font-face {
17 | // font-family: "GT Walsheim Pro";
18 | // src: url("/static/fonts/GT-Walsheim-Pro-Bold.otf") format("opentype");
19 | // font-weight: 700;
20 | // font-style: normal;
21 | // }
22 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/tabs/tabs.html:
--------------------------------------------------------------------------------
1 |
2 |
3 | {% for tab in tabs %}
4 | {{ tab.header }}
9 | {% endfor %}
10 |
11 |
12 | {% for tab in tabs %}
13 |
14 | {{ tab.content }}
15 |
16 | {% endfor %}
17 |
18 |
{% translate "Are you sure you want to sign out?" %}
7 |
20 | {% endblock account_content %}
21 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/form/input.html:
--------------------------------------------------------------------------------
1 | {% load heroicons %}
2 |
3 |
6 | {% component "widget" field=field / %}
7 | {% if field.label %}
8 | {% component "label" field=field %}
9 | {{ field.label }}
10 | {% endcomponent %}
11 | {% endif %}
12 |
13 | {% if field.errors %}
14 |
{% heroicon_solid "exclamation-circle" class="text-error" %}
15 |
{{ field.errors }}
16 | {% endif %}
17 | {% if field.help_text %}
18 |
{{ field.help_text|safe }}
20 | {% endif %}
21 |
2 | {% for group, options, index in widget.optgroups %}
3 | {% if group %}
{{ group }}
{% endif %}
4 | {% for option in options %}
5 |
6 | {{ option.label }}
14 |
15 | {% endfor %}
16 | {% endfor %}
17 |
8 | {% heroicon_micro "arrow-long-left" class="inline-block" %} {% translate "Sign In" %}
9 |
10 | {% endblock account_back %}
11 | {% block account_content %}
12 | {% if user.is_authenticated %}
13 | {% include "account/snippets/already_logged_in.html" %}
14 | {% else %}
15 |
16 |
{% translate "We have sent you an e-mail." %}
17 |
18 | {% translate "If you have not received it please check your spam folder. Otherwise contact us if you do not receive it in a few minutes." %}
19 |
20 |
7 |
8 |
9 | {% block account_back %}
10 | {% endblock account_back %}
11 |
12 |
13 |
18 |
19 | {% block account_title %}
20 | {% endblock account_title %}
21 |
22 | {% block account_content %}
23 | {% endblock account_content %}
24 |
25 |
3 | {% component "popover" button_class="group flex items-center rounded-lg w-full p-1 hover:bg-gray-800/10" %}
4 | {% fill "trigger" %}
5 |
Open user menu
6 |
7 |
10 |
11 | {{ user_name }}
12 | {% if show_chevron|default:True %}
13 | {% heroicon_micro "chevron-down" %}
14 | {% endif %}
15 |
16 |
17 | {% endfill %}
18 | {% fill "content" %}
19 |
20 | {% slot "menu_items" default %}
21 | {% endslot %}
22 |
23 | {% endfill %}
24 | {% endcomponent %}
25 |
12 | {% url 'account_reset_password' as passwd_reset_url %}
13 | {% blocktranslate %}The password reset link was invalid, possibly because it has already been used. Please request a new password reset .{% endblocktranslate %}
14 |
15 | {% else %}
16 |
23 | {% endif %}
24 | {% endblock account_content %}
25 |
--------------------------------------------------------------------------------
/docs/source/conf.py:
--------------------------------------------------------------------------------
1 | # Configuration file for the Sphinx documentation builder.
2 | #
3 | # For the full list of built-in configuration values, see the documentation:
4 | # https://www.sphinx-doc.org/en/master/usage/configuration.html
5 |
6 | # -- Project information -----------------------------------------------------
7 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8 |
9 | project = "Hydra"
10 | copyright = "2023, Lightmatter Team"
11 | author = "Lightmatter Team"
12 | release = "3.0"
13 |
14 | # -- General configuration ---------------------------------------------------
15 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
16 |
17 | extensions = []
18 |
19 | templates_path = ["_templates"]
20 | exclude_patterns = []
21 |
22 |
23 | # -- Options for HTML output -------------------------------------------------
24 | # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
25 |
26 | html_theme = "furo"
27 | html_static_path = ["_static"]
28 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/form/widgets/password.html:
--------------------------------------------------------------------------------
1 | {% load replace %}
2 | {% load heroicons %}
3 |
22 |
--------------------------------------------------------------------------------
/template/mise-tasks/db/setup:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env bash
2 | # @desc Set up project database
3 | # @depends db:create-user
4 |
5 | set -euo pipefail
6 |
7 | # Source colors
8 | source "$(dirname "$0")/../utils/colors"
9 |
10 | # Get project name from mise config
11 | project_name=$ENV_NAME
12 |
13 | if [ -z "$project_name" ]; then
14 | color_error "Error: project_name not set in mise.toml"
15 | exit 1
16 | fi
17 |
18 | # Check if database exists
19 | if [ "$(psql -tAc "SELECT 1 FROM pg_database WHERE datname='$project_name'" postgres)" != "1" ]; then
20 | color_info "Creating project database..."
21 | if psql postgres -c "create role $project_name with createdb encrypted password '$project_name' login;" &&\
22 | psql postgres -c "alter user $project_name superuser;" &&\
23 | psql postgres -c "create database $project_name with owner $project_name;"; then
24 | color_success "Project database created successfully"
25 | else
26 | color_error "Failed to create project database"
27 | exit 1
28 | fi
29 | else
30 | color_warning "Project database already exists"
31 | fi
32 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/svg/github.svg:
--------------------------------------------------------------------------------
1 |
2 |
6 | Github
7 |
11 |
12 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/header/mobile_menu_button.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
8 | Open main menu
9 |
10 |
17 |
18 |
10 | {% component "profile-popover"
11 | avatar_url="https://images.unsplash.com/photo-1601814933824-fd0b574dd592?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=1112&q=80"
12 | user_name=request.user.get_full_name
13 | user_email=request.user.email
14 | %}
15 | {% include "header/profile_menu_item.html" with label="Your Profile" icon="user" only %}
16 | {% include "header/profile_menu_item.html" with label="Settings" icon="cog-6-tooth" only %}
17 | {% url 'account_logout' as logout_url %}
18 | {% include "header/profile_menu_item.html" with label="Sign out" href=logout_url icon="arrow-right-start-on-rectangle" only %}
19 | {% endcomponent %}
20 |
21 | {% endif %}
22 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/form/widgets/radio.html:
--------------------------------------------------------------------------------
1 | {# todo: get widget.required working, but need peer-invalid error messages first #}
2 |
6 | {% for group, options, index in widget.optgroups %}
7 | {% if group %}
{{ group }} {% endif %}
8 | {% for option in options %}
9 |
10 |
16 |
19 |
20 | {{ option.label }}
21 |
22 |
23 | {% endfor %}
24 | {% endfor %}
25 |
3 |
7 | Dribble
8 |
12 |
13 |
--------------------------------------------------------------------------------
/template/Dockerfile.jinja:
--------------------------------------------------------------------------------
1 | FROM ghcr.io/astral-sh/uv:python3.13-bookworm-slim AS builder
2 | ENV UV_COMPILE_BYTECODE=1 UV_LINK_MODE=copy
3 | WORKDIR /app
4 | RUN --mount=type=cache,target=/root/.cache/uv \
5 | --mount=type=bind,source=uv.lock,target=uv.lock \
6 | --mount=type=bind,source=pyproject.toml,target=pyproject.toml \
7 | uv sync --frozen --no-install-project --no-dev
8 | COPY . /app
9 | RUN --mount=type=cache,target=/root/.cache/uv \
10 | uv sync --frozen --no-dev
11 |
12 |
13 | FROM node:20-slim as js-builder
14 | WORKDIR /app
15 | COPY package*.json ./
16 | RUN npm ci
17 | COPY . .
18 | RUN npm run build
19 |
20 | # In your main stage:
21 |
22 | FROM python:3.13-slim-bookworm as web
23 | # Copy the application from the builder
24 | COPY --from=builder --chown=app:app /app /app
25 | COPY --from=js-builder /app/[[project_name]]/static_source/assets /app/[[project_name]]/static_source/assets
26 | COPY --from=js-builder /app/[[project_name]]/static_source/manifest.json /app/[[project_name]]/static_source/
27 |
28 | # Place executables in the environment at the front of the path
29 | WORKDIR /app
30 | ENV PATH="/app/.venv/bin:$PATH"
31 | RUN python manage.py collectstatic --noinput --settings [[project_name]].config.settings.build
32 | EXPOSE 8000
33 |
34 | CMD ["gunicorn"]
35 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/alert/alert.html:
--------------------------------------------------------------------------------
1 | {% load heroicons %}
2 |
3 |
17 |
18 |
{% heroicon_solid icon class="h-5 w-5" %}
19 |
22 |
23 |
24 |
27 | Dismiss
28 | {% heroicon_mini "x-mark" class="h-5 w-5" %}
29 |
30 |
31 |
32 |
33 |
2 |
3 |
39 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/account/password_reset.html:
--------------------------------------------------------------------------------
1 | {% extends "account/account_base.html" %}
2 | {% load heroicons %}
3 | {% block account_title %}
4 | {% translate "Reset Password" %}
5 | {% endblock account_title %}
6 | {% block account_back %}
7 |
8 | {% heroicon_micro "arrow-long-left" class="inline-block" %} {% translate "Sign In" %}
9 |
10 | {% endblock account_back %}
11 | {% block account_content %}
12 | {% if user.is_authenticated %}
13 | {% include "account/snippets/already_logged_in.html" %}
14 | {% else %}
15 |
16 |
{% translate "Forgotten your password?" %}
17 |
{% translate "Enter your e-mail address below, and we'll send you an e-mail allowing you to reset it." %}
18 |
{% translate "Please contact us if you have any trouble resetting your password." %}
29 | {% endif %}
30 | {% endblock account_content %}
31 |
--------------------------------------------------------------------------------
/template/[[project_name]]/static_source/css/base/_index.scss:
--------------------------------------------------------------------------------
1 | @forward "colors";
2 | @forward "typography";
3 | @forward "fonts";
4 | @forward "forms";
5 | @forward "flatpickr";
6 |
7 | /* sticky footer */
8 | body {
9 | display: flex;
10 | flex-direction: column;
11 | min-height: 100vh;
12 | height: 100%;
13 | overflow-x: hidden;
14 |
15 | // Example font-family inclusion
16 | // font-family: "GT Walsheim Pro", sans-serif;
17 | }
18 |
19 | html {
20 | -webkit-tap-highlight-color: transparent;
21 |
22 | // For better cross-browser consistency
23 | width: 100vw;
24 | }
25 |
26 |
27 | // for center positioned elements, that should stay in the same position
28 | // when the y-scrollbar is present or not
29 | // you could also do this as "padding-left: calc(100vw - 100%);"
30 | // which will shrink the viewport vs hiding under the scrollbar
31 | @mixin no-jitter-scrollbar {
32 | margin-right: calc(-1 * (100vw - 100%));
33 | }
34 |
35 | #app {
36 | flex: 1 0 auto;
37 | flex-direction: column;
38 |
39 | @include no-jitter-scrollbar;
40 | }
41 |
42 | header {
43 | @include no-jitter-scrollbar;
44 | }
45 |
46 | footer {
47 | flex-shrink: 0;
48 |
49 | @include no-jitter-scrollbar;
50 | }
51 |
52 | #loading-body {
53 | position: fixed;
54 | top: 50%;
55 | z-index: 40;
56 | }
57 |
58 | /* alpine */
59 | [x-cloak] {
60 | display: none !important;
61 | }
62 |
--------------------------------------------------------------------------------
/template/[[project_name]]/static_source/js/links.ts:
--------------------------------------------------------------------------------
1 | export function isExternalLink(link: HTMLAnchorElement) {
2 | const { href } = link;
3 |
4 | return !(
5 | !href
6 | || href.startsWith(window.location.origin)
7 | || href[0] === "?"
8 | || href[0] === "/"
9 | || href[0] === "#"
10 | || href.substring(0, 4) === "tel:"
11 | || href.substring(0, 7) === "mailto:"
12 | );
13 | }
14 |
15 | export function isCurrentPage(link: HTMLAnchorElement) {
16 | //javascript controls tend to point to #
17 | if (link.getAttribute('href') === '#') {
18 | return false;
19 | }
20 |
21 | const currentUrl = window.location.href;
22 | const currentPath = window.location.pathname;
23 | const href = link.href.split("#")[0];
24 |
25 | return href === currentUrl || href === currentPath;
26 | }
27 |
28 | export default function linksInit() {
29 | const links = document.getElementsByTagName("a");
30 |
31 | Array.from(links).forEach((link) => {
32 | link.classList.remove("active");
33 |
34 | if (isExternalLink(link)) {
35 | link.target = "_blank";
36 | }
37 |
38 | if (isCurrentPage(link)) {
39 | link.classList.add("active");
40 | }
41 | });
42 | }
43 |
44 | if (typeof document !== "undefined") {
45 | document.addEventListener("htmx:pushedIntoHistory", linksInit);
46 | document.addEventListener("DOMContentLoaded", linksInit);
47 | }
48 |
--------------------------------------------------------------------------------
/template/[[project_name]]/config/wsgi.py.jinja:
--------------------------------------------------------------------------------
1 | # pylint: disable-all
2 |
3 | """
4 | WSGI config for [[project_name]] project.
5 | This module contains the WSGI application used by Django's development server
6 | and any production WSGI deployments. It should expose a module-level variable
7 | named ``application``. Django's ``runserver`` and ``runfcgi`` commands discover
8 | this application via the ``WSGI_APPLICATION`` setting.
9 | Usually you will have the standard Django WSGI application here, but it also
10 | might make sense to replace the whole Django WSGI application with a custom one
11 | that later delegates to the Django one. For example, you could introduce WSGI
12 | middleware here, or combine a Django application with an application of another
13 | framework.
14 | """
15 |
16 | import os
17 |
18 | from django.core.wsgi import get_wsgi_application
19 |
20 | # We defer to a DJANGO_SETTINGS_MODULE already in the environment. This breaks
21 | # if running multiple sites in the same mod_wsgi process. To fix this, use
22 | # mod_wsgi daemon mode with each site in its own daemon process, or use
23 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "[[project_name]].config.settings.production")
24 |
25 | # This application object is used by any WSGI server configured to use this
26 | # file. This includes Django's development server, if the WSGI_APPLICATION
27 | # setting points here.
28 | application = get_wsgi_application()
29 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/svg/apple.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 | Apple
8 |
12 |
13 |
--------------------------------------------------------------------------------
/template/[[project_name]]/static_source/img/logo.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
42 | DJANGO-HYDRA
43 |
44 |
45 |
--------------------------------------------------------------------------------
/template/[[project_name]]/util/middleware.py:
--------------------------------------------------------------------------------
1 | import zoneinfo
2 |
3 | from django.contrib.messages import get_messages
4 | from django.template.loader import render_to_string
5 | from django.utils import timezone
6 |
7 |
8 | def attach_messages(response):
9 | if not (req_messages := get_messages(response._request)).used:
10 | messages = render_to_string(
11 | "messages.html",
12 | {"messages": req_messages}, # NOQA
13 | )
14 | response.content = response.content + messages.encode(response.charset)
15 | return response
16 |
17 |
18 | class HTMXMessageMiddleware:
19 | def __init__(self, get_response):
20 | self.get_response = get_response
21 |
22 | def __call__(self, request):
23 | response = self.get_response(request)
24 | return response
25 |
26 | def process_template_response(self, request, response):
27 | if request.htmx and not request.htmx.boosted:
28 | response.add_post_render_callback(attach_messages)
29 | return response
30 |
31 |
32 | class TimezoneMiddleware:
33 | def __init__(self, get_response):
34 | self.get_response = get_response
35 |
36 | def __call__(self, request):
37 | tzname = request.headers.get("X-Timezone", None)
38 | if tzname:
39 | timezone.activate(zoneinfo.ZoneInfo(tzname))
40 | else:
41 | timezone.deactivate()
42 | return self.get_response(request)
43 |
--------------------------------------------------------------------------------
/template/[[project_name]]/static_source/img/logomark.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
39 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/account/signup.html:
--------------------------------------------------------------------------------
1 | {% extends "account/account_base.html" %}
2 | {% block title %}
3 | {{ block.super }}| {% translate "Register" %}
4 | {% endblock title %}
5 | {% block account_title %}
6 | {% translate "Register" %}
7 | {% endblock account_title %}
8 | {% block account_content %}
9 |
24 | {% translate "Already have an account?" %}
25 |
26 |
29 |
30 | {% translate "Or" %}
31 |
32 |
34 |
{% include "account/snippets/social_login_buttons.html" %}
35 |
25 | {% translate "Need an account?" %} {% translate "Register" %}
26 |
27 |
28 |
31 |
32 | {% translate "Or" %}
33 |
34 |
36 |
{% include "account/snippets/social_login_buttons.html" %}
37 |
3 |
7 | Django
8 |
12 |
13 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/alert/alert.py:
--------------------------------------------------------------------------------
1 | from django_components import Component, register
2 |
3 |
4 | @register("alert")
5 | class Alert(Component):
6 | """An alert component that works with Django's messages framework.
7 |
8 | Usage:
9 | {% component "alert" message=message %}{% endcomponent %}
10 | """
11 |
12 | template_name = "alert.html"
13 |
14 | level_icons = {
15 | "error": "exclamation-circle",
16 | "warning": "exclamation-triangle",
17 | "success": "check-circle",
18 | "info": "information-circle",
19 | "debug": "information-circle",
20 | }
21 |
22 | level_classes = {
23 | "debug": "bg-info/5 text-info border border-info/10 ring-1 ring-info/10",
24 | "info": "bg-info/5 text-info border border-info/10 ring-1 ring-info/10",
25 | "success": "bg-success/5 text-success border border-success/10 ring-1 ring-success/10",
26 | "warning": "bg-warning/5 text-warning border border-warning/10 ring-1 ring-warning/10",
27 | "error": "bg-error/5 text-error border border-error/10 ring-1 ring-error/10",
28 | }
29 |
30 | def get_context_data(self, message):
31 | level_tag = message.level_tag
32 | level_class = self.level_classes.get(level_tag, self.level_classes["info"])
33 | icon = self.level_icons.get(level_tag, self.level_icons["info"])
34 |
35 | return {
36 | "message": message,
37 | "icon": icon,
38 | "level_class": level_class,
39 | "timeout": 9000,
40 | }
41 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/form/toggle.html:
--------------------------------------------------------------------------------
1 |
2 |
4 | {% if field.label %}
5 | {% component "label" field=field %}
6 | {{ field.label }}
7 | {% endcomponent %}
8 | {% endif %}
9 |
16 |
28 |
31 |
32 |
33 | {% if field.errors %}
{{ field.errors }}
{% endif %}
34 | {% if field.help_text %}
35 |
{{ field.help_text|safe }}
37 | {% endif %}
38 |
3 |
7 | Google
8 |
9 |
22 |
23 |
24 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/svg/linkedin.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 | Linkedin
8 |
12 |
13 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/base.html:
--------------------------------------------------------------------------------
1 | {% load django_vite %}
2 | {% load django_htmx %}
3 |
4 |
5 |
6 |
21 | {% block title %}
22 | {% endblock title %}
23 |
24 | {% block extra_head %}
25 | {% endblock extra_head %}
26 |
27 |
31 | {% include "header/base.html" %}
32 |
33 | {% block content %}
34 | {% endblock content %}
35 | {# hx-preserve persists this element on htmx swaps
36 | so even if swapping an entire new page this element exists
37 | for content to be swapped in as an oob-swap #}
38 |
39 | {% include "messages.html" %}
40 |
41 |
=> {
20 | const [eventName, value, enableTime] = args as [string, string, boolean];
21 | return {
22 | eventName,
23 | value,
24 | enableTime,
25 | picker: null,
26 | active: false,
27 | init() {
28 | inputListener.call(this);
29 |
30 | if (this.value === "None") {
31 | this.value = "";
32 | }
33 |
34 | // see https://flatpickr.js.org/formatting/
35 | const dateFormat = enableTime ? "m/d/Y H:i" : "m/d/Y";
36 |
37 | this.picker = flatpickr(this.$refs.picker, {
38 | mode: "single",
39 | enableTime,
40 | dateFormat,
41 | allowInput: true,
42 | defaultDate: value,
43 | onChange: (_, dateString) => {
44 | this.value = dateString;
45 | },
46 | });
47 |
48 | this.$watch("value", () => {
49 | //this.picker?.setDate(this.value); //this is in the alpine docs but doesn't work with allow input
50 | if (this.eventName !== "") this.$dispatch(this.eventName, { value: this.value });
51 | });
52 |
53 | if (this.value) {
54 | this.active = true;
55 | }
56 | },
57 | }
58 | };
59 |
60 | AlpineInstance.data("dateTime", dateTime);
61 |
--------------------------------------------------------------------------------
/template/[[project_name]]/home/views.py:
--------------------------------------------------------------------------------
1 | # Create your views here.
2 |
3 | from django.contrib import messages
4 | from django.template.response import TemplateResponse
5 | from django.views.defaults import (
6 | bad_request,
7 | page_not_found,
8 | permission_denied,
9 | server_error,
10 | )
11 | from django.views.generic.edit import FormView
12 | from django_htmx.http import HttpResponseClientRedirect, HttpResponseClientRefresh
13 |
14 | from .forms import TestForm
15 |
16 |
17 | def error(request):
18 | """Generate an exception. Useful for e.g. configuring Sentry"""
19 | raise Exception("Make response code 500!")
20 |
21 |
22 | def current_time(request):
23 | """Generate the current time. Useful for testing htmx"""
24 | messages.info(request, "updated the current time")
25 | return TemplateResponse(request, "samples/current_time.html")
26 |
27 |
28 | def test_message_redirect(request):
29 | messages.info(request, "testing redirect")
30 | return HttpResponseClientRedirect("/")
31 |
32 |
33 | def test_message_refresh(request):
34 | messages.info(request, "testing refresh")
35 | return HttpResponseClientRefresh()
36 |
37 |
38 | def FourHundy(request, exception):
39 | return bad_request(request, exception, template_name="400.html")
40 |
41 |
42 | def FourOhThree(request, exception):
43 | return permission_denied(request, exception, template_name="403.html")
44 |
45 |
46 | def FourOhFour(request, exception):
47 | return page_not_found(request, exception, template_name="404.html")
48 |
49 |
50 | def WorkedLocally(request):
51 | return server_error(request, template_name="500.html")
52 |
53 |
54 | class FormTestView(FormView):
55 | template_name = "home/form_test.html"
56 | form_class = TestForm
57 | success_url = "/"
58 |
59 | def form_valid(self, form):
60 | return super().form_invalid(form)
61 |
--------------------------------------------------------------------------------
/docs/source/debugging.rst:
--------------------------------------------------------------------------------
1 | Local Development & Debugging
2 | ==============================
3 |
4 | Running the local development servers
5 | --------------------------------------
6 |
7 | This app uses vite to compile/transpile assets. The app is equipped to be served from `127.0.0.1:8000` or `localhost:8000`.
8 |
9 | First run the python server:
10 |
11 | .. code-block:: console
12 |
13 | $ ./manage.py runserver_plus
14 |
15 | Then in a new tab, run the vite server:
16 |
17 | .. code-block:: console
18 |
19 | $ npm run dev
20 |
21 | Debugging
22 | ----------
23 |
24 | To access a python shell pre-populated with Django models and local env:
25 |
26 | .. code-block:: console
27 |
28 | $ ./manage.py shell_plus
29 |
30 | To add a breakpoint in your python code, add the following code to your `.bashrc` or `.zshrc`:
31 |
32 | .. code-block:: console
33 |
34 | $ export PYTHONBREAKPOINT="pudb.set_trace"
35 |
36 | Then add the following to your python code:
37 |
38 | .. code-block:: python
39 |
40 | breakpoint()
41 |
42 | If the above fails or you prefer a more immediate solution, you can add the following to your code:
43 |
44 | .. code-block:: python
45 |
46 | import pudb; pu.db
47 |
48 | As an alternative to pudb and its debugger, this project also has the IPython debugger (ipdb). You can access ipdb by adding the following to your code:
49 |
50 | .. code-block:: python
51 |
52 | import ipdb;
53 | ipdb.set_trace()
54 |
55 | For ease of local development, `icecream `_ is preconfigured and ready to use.
56 |
57 | Logging
58 | -------
59 |
60 | Logging is configured in the base.py settings. To use the logger in your backend code you can add the following:
61 |
62 | .. code-block:: python
63 |
64 | import logging
65 |
66 | logger = logging.getLogger(__name__)
67 |
68 | logger.info("this is an info level log")
69 |
--------------------------------------------------------------------------------
/template/[[project_name]]/static_source/css/components/_buttons.scss:
--------------------------------------------------------------------------------
1 | @layer components {
2 | .btn {
3 | @apply inline-flex items-center justify-center;
4 | @apply rounded focus:outline-none focus:ring-2 focus:ring-offset-2;
5 |
6 | /* Base spacing */
7 | @apply px-4 py-2;
8 | @apply space-x-2;
9 |
10 | /* Size variants */
11 | &-sm {
12 | @apply px-3 py-1.5 text-sm space-x-1.5;
13 | }
14 |
15 | &-md {
16 | @apply px-4 py-2 text-base space-x-2;
17 | }
18 |
19 | &-lg {
20 | @apply px-5 py-2.5 text-lg space-x-2.5;
21 | }
22 |
23 | /* Color variants using our theme variables */
24 | &.btn-primary {
25 | @apply bg-primary text-primary-content;
26 | @apply hover:bg-primary-focus;
27 | @apply focus:ring-primary;
28 |
29 | &.btn-outline {
30 | @apply bg-transparent;
31 | @apply border border-primary;
32 | @apply text-primary;
33 | @apply hover:bg-primary hover:text-primary-content;
34 | @apply focus:ring-primary;
35 | }
36 | }
37 |
38 | &.btn-secondary {
39 | @apply bg-secondary text-secondary-content;
40 | @apply hover:bg-secondary-focus;
41 | @apply focus:ring-secondary;
42 |
43 | &.btn-outline {
44 | @apply bg-transparent;
45 | @apply border border-secondary;
46 | @apply text-secondary;
47 | @apply hover:bg-secondary-focus hover:text-secondary-content;
48 | @apply focus:ring-secondary;
49 | }
50 | }
51 |
52 |
53 |
54 | /* Disabled state */
55 | &[disabled], &.disabled {
56 | @apply opacity-50 cursor-not-allowed pointer-events-none;
57 | }
58 |
59 | /* HTMX States */
60 | &.htmx-request {
61 | @apply opacity-75 cursor-wait;
62 | }
63 |
64 | &.htmx-swapping {
65 | @apply opacity-50 transition-opacity duration-200;
66 | }
67 | }
68 | }
69 |
--------------------------------------------------------------------------------
/template/[[project_name]]/static_source/css/base/_flatpickr.scss:
--------------------------------------------------------------------------------
1 | // stylelint-disable selector-class-pattern -- We can't control the class names so:
2 |
3 | .flatpickr-calendar {
4 | width: auto !important;
5 | padding: 10px !important;
6 | border-radius: 15px !important;
7 |
8 | @apply bg-white #{!important};
9 | }
10 |
11 | .flatpickr-current-month .numInputWrapper {
12 | margin-left: 0.5em !important;
13 | }
14 |
15 | .flatpickr-months .flatpickr-month,
16 | .flatpickr-monthDropdown-months,
17 | .flatpickr-weekdays,
18 | span.flatpickr-weekday {
19 | @apply bg-white #{!important};
20 | }
21 |
22 | .flatpickr-current-month input.cur-year,
23 | .flatpickr-current-month .flatpickr-monthDropdown-months {
24 | border-radius: 3px !important;
25 | }
26 |
27 | .flatpickr-months {
28 | position: relative;
29 | }
30 |
31 | .flatpickr-months .flatpickr-prev-month:hover svg,
32 | .flatpickr-months .flatpickr-next-month:hover svg {
33 | @apply fill-red-500 #{!important};
34 | }
35 |
36 | .flatpickr-weekdays {
37 | padding: 25px 0 15px;
38 | }
39 |
40 | .flatpickr-innerContainer {
41 | border: 0 !important;
42 | }
43 |
44 | .flatpickr-days {
45 | border: 0 !important;
46 | }
47 |
48 | .flatpickr-day.selected,
49 | .flatpickr-day.startRange,
50 | .flatpickr-day.endRange,
51 | .flatpickr-day.selected.inRange,
52 | .flatpickr-day.startRange.inRange,
53 | .flatpickr-day.endRange.inRange,
54 | .flatpickr-day.selected:focus,
55 | .flatpickr-day.startRange:focus,
56 | .flatpickr-day.endRange:focus,
57 | .flatpickr-day.selected:hover,
58 | .flatpickr-day.startRange:hover,
59 | .flatpickr-day.endRange:hover,
60 | .flatpickr-day.selected.prevMonthDay,
61 | .flatpickr-day.startRange.prevMonthDay,
62 | .flatpickr-day.endRange.prevMonthDay,
63 | .flatpickr-day.selected.nextMonthDay,
64 | .flatpickr-day.startRange.nextMonthDay,
65 | .flatpickr-day.endRange.nextMonthDay {
66 | @apply bg-red-500 border-red-500 #{!important};
67 | }
68 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/svg/instagram.svg:
--------------------------------------------------------------------------------
1 |
2 |
6 | Instagram
7 |
11 |
12 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/svg/discord.svg:
--------------------------------------------------------------------------------
1 |
2 |
3 |
7 | Discord
8 |
12 |
13 |
--------------------------------------------------------------------------------
/template/[[project_name]]/config/urls.py.jinja:
--------------------------------------------------------------------------------
1 | # flake8: noqa: F811
2 | from django.conf import settings
3 | from django.conf.urls import handler400, handler403, handler404, handler500
4 | from django.contrib import admin
5 | from django.urls import include, path, re_path
6 |
7 | from [[project_name]].home.views import FourHundy, FourOhFour, FourOhThree, WorkedLocally
8 |
9 | handler400 = FourHundy
10 | handler403 = FourOhThree
11 | handler404 = FourOhFour
12 | handler500 = WorkedLocally
13 |
14 |
15 | urlpatterns = []
16 |
17 | if "silk" in settings.INSTALLED_APPS:
18 | urlpatterns += [path("silk", include("silk.urls", namespace="silk"))]
19 |
20 | if settings.DEBUG:
21 | # This allows the error pages to be debugged during development, just visit
22 | # these url in browser to see how these error pages look like.
23 | urlpatterns += [
24 | path(
25 | "400/",
26 | handler400,
27 | kwargs={"exception": Exception("Bad Request!")},
28 | ),
29 | path(
30 | "403/",
31 | handler403,
32 | kwargs={"exception": Exception("Permission Denied")},
33 | ),
34 | path(
35 | "404/",
36 | handler404,
37 | kwargs={"exception": Exception("Page not Found")},
38 | ),
39 | path("500/", handler500),
40 | ]
41 |
42 | if "robots" in settings.INSTALLED_APPS:
43 | urlpatterns.append(
44 | re_path(r"^robots\.txt", include("robots.urls")),
45 | )
46 |
47 | if "debug_toolbar" in settings.INSTALLED_APPS:
48 | import debug_toolbar
49 |
50 | urlpatterns = [path("__debug__/", include(debug_toolbar.urls))] + urlpatterns
51 |
52 |
53 | urlpatterns += [
54 | path("account/", include("[[project_name]].user.urls", namespace="user")),
55 | path("account/", include("allauth.urls")),
56 | path("admin/", admin.site.urls),
57 | path("hijack/", include("hijack.urls")),
58 | path("", include("[[project_name]].home.urls")),
59 | path("", include("django_components.urls")),
60 | ]
61 |
--------------------------------------------------------------------------------
/template/.pre-commit-config.yaml.jinja:
--------------------------------------------------------------------------------
1 | repos:
2 | ## system
3 | - repo: https://github.com/adamchainz/django-upgrade
4 | rev: 1.22.2
5 | hooks:
6 | - id: django-upgrade
7 | args: [--target-version, "5.1"]
8 |
9 | - repo: https://github.com/pre-commit/pre-commit-hooks
10 | rev: v5.0.0
11 | hooks:
12 | - id: check-yaml
13 | - id: check-merge-conflict
14 | - id: check-toml
15 | - id: trailing-whitespace
16 | - id: name-tests-test
17 | - id: debug-statements
18 | - id: mixed-line-ending
19 | - repo: https://github.com/pycqa/doc8
20 | rev: v1.1.2
21 | hooks:
22 | - id: doc8
23 |
24 | #python
25 | - repo: https://github.com/astral-sh/ruff-pre-commit
26 | rev: v0.9.1
27 | hooks:
28 | - id: ruff
29 | args: [--fix]
30 | - id: ruff-format
31 | - repo: https://github.com/astral-sh/uv-pre-commit
32 | rev: 0.5.18
33 | hooks:
34 | - id: uv-lock
35 |
36 | - repo: https://github.com/djlint/djLint
37 | rev: v1.36.4
38 | hooks:
39 | # TODO: Turn on when this works with django component and alpine.js
40 | # - id: djlint-reformat-django
41 | # files: "\\.html"
42 | - id: djlint-django
43 | files: "\\.html"
44 |
45 | # TODO: https://github.com/adamchainz/pre-commit-oxipng
46 |
47 |
48 | - repo: local
49 | hooks:
50 | - id: stylelint
51 | name: stylelint
52 | entry: npx stylelint
53 | language: node
54 | files: ^[[project_name]]/static_source/
55 | types_or: [css, scss]
56 | args: [--fix, --allow-empty-input, --cache]
57 |
58 | - id: eslint
59 | name: eslint
60 | entry: npx eslint
61 | language: node
62 | files: ^[[project_name]]/static_source/
63 | types_or: [javascript, ts]
64 | args: [--fix]
65 |
66 | - id: tsc
67 | name: tsc
68 | entry: npx tsc --noEmit
69 | files: ^[[project_name]]/static_source/
70 | language: system
71 | types_or: [javascript, ts]
72 | pass_filenames: false
73 |
--------------------------------------------------------------------------------
/template/[[project_name]]/static_source/js/forms/input.ts:
--------------------------------------------------------------------------------
1 | import AlpineInstance, { AlpineComponent } from "alpinejs";
2 | import inputListener from "./common";
3 |
4 | interface Input {
5 | //callback requires indexing to string and symbol
6 | [key: string]: unknown;
7 | [key: symbol]: unknown;
8 | //real types
9 | eventName: string;
10 | value: string | boolean;
11 | type: string;
12 | active: boolean;
13 | }
14 |
15 |
16 | const input = (...args: unknown[]): AlpineComponent
8 |
9 | Hello There!
10 |
11 |
{% include "samples/current_time.html" %}
12 | {% component "button"
13 | attrs:hx-get="{% url 'current_time' %}"
14 | attrs:hx-target="#current-time"
15 | attrs:hx-swap="innerHTML"
16 | attrs:hx-push-url="false" %}
17 | Refresh time
18 | {% endcomponent %}
19 | {% component "button"
20 | color="secondary"
21 | attrs:hx-get="{% url 'test_redirect' %}"
22 | attrs:hx-push-url="false" %}
23 | Test hx-redirect with messages
24 | {% endcomponent %}
25 | {% component "button"
26 | variant="outline"
27 | attrs:hx-get="{% url 'test_refresh' %}"
28 | %}
29 | Test hx-refresh with messages
30 | {% endcomponent %}
31 |
32 | {% component "popover" button_class="group flex items-center rounded-lg w-full p-1 hover:bg-gray-800/10" %}
33 | {% fill "trigger" %}
34 | {% component "button" %}
35 | open menu {% heroicon_micro "chevron-down" %}
36 | {% endcomponent %}
37 | {% endfill %}
38 | {% fill "content" %}
39 |
Menu Item One
40 |
Menu Item two
41 | {% endfill %}
42 | {% endcomponent %}
43 | {% component "modal" %}
44 | {% fill "title" %}
45 | welcome to hydra!
46 | {% endfill %}
47 | {% fill "content" %}
48 | This is a hydra modal
49 | {% endfill %}
50 | {% endcomponent %}
51 | {% component "tabs" %}
52 | {% component "tab_item" header="TabOne" %}
53 |
54 |
Testing 123
55 |
56 | {% endcomponent %}
57 | {% component "tab_item" header="TabTwo" %}
58 |
59 |
Testing 124
60 |
61 | {% endcomponent %}
62 | {% endcomponent %}
63 |
64 |
4 |
5 |
6 | {% slot "trigger" %}
7 | {% component "button" %}
8 | Open Dialog
9 | {% endcomponent %}
10 | {% endslot %}
11 |
12 |
13 |
17 |
18 |
21 |
22 |
23 |
27 |
28 | {% slot "close" %}
29 |
30 |
33 | Close modal
34 | {% heroicon_micro "x-mark" %}
35 |
36 |
37 | {% endslot %}
38 |
39 |
40 | {% slot "body" %}
41 |
42 |
43 | {% slot "title" %}
44 | {% endslot "title" %}
45 |
46 |
47 | {% slot "content" required default %}
48 |
49 |
Once published, your content will be visible to everyone.
50 |
51 | {% endslot %}
52 | {% endslot %}
53 |
54 |
55 |
56 | {% slot "footer" %}
57 | {% component "button" attrs:x-on:click="$dialog.close()" %}
58 | Ok
59 | {% endcomponent %}
60 | {% endslot %}
61 |
62 |
63 |
64 |
65 |
2 |
3 |
12 |
13 |
22 |
23 |
32 |
33 |
42 |
43 |
52 |
53 |
--------------------------------------------------------------------------------
/template/.vscode/launch.json.jinja:
--------------------------------------------------------------------------------
1 | {
2 | // Use IntelliSense to learn about possible attributes.
3 | // Hover to view descriptions of existing attributes.
4 | // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5 | "version": "0.2.0",
6 | "compounds": [
7 | {
8 | "name": "Debug [[ project_name_verbose ]]",
9 | "configurations": ["Django", "Vite", "Browser Debug"],
10 | "stopAll": true
11 | }
12 | ],
13 | "configurations": [
14 | {
15 | "name": "Django Command",
16 | "type": "python",
17 | "request": "launch",
18 | "program": "${workspaceFolder}/manage.py",
19 | "args": "${input:djangoManage}",
20 | "django": true,
21 | "justMyCode": true,
22 | "cwd": "${workspaceFolder}",
23 | "preLaunchTask": "poetryInstall"
24 | },
25 | {
26 | "name": "Django",
27 | "type": "python",
28 | "request": "launch",
29 | "program": "${workspaceFolder}/manage.py",
30 | "args": ["runserver"],
31 | "django": true,
32 | "justMyCode": true,
33 | "presentation": { "hidden": true },
34 | "cwd": "${workspaceFolder}",
35 | "preLaunchTask": "poetryInstall"
36 | // Disabled this in favor of "Browser Debug" as this doesn't stop automatically
37 | // https://github.com/microsoft/vscode/issues/163124
38 | //
39 | // "serverReadyAction": {
40 | // "pattern": ".*(https?:\\/\\/\\S+:[0-9]+\\/?).*",
41 | // "uriFormat": "%s",
42 | // "action": "debugWithChrome"
43 | // }
44 | },
45 | {
46 | "name": "Browser Debug",
47 | "type": "chrome",
48 | "request": "launch",
49 | "presentation": { "hidden": true },
50 | "url": "http://localhost:8000"
51 | },
52 | {
53 | "name": "Vite",
54 | "type": "node",
55 | "request": "launch",
56 | "runtimeExecutable": "npm",
57 | "runtimeArgs": ["run", "dev"],
58 | "presentation": { "hidden": true },
59 | "cwd": "${workspaceFolder}",
60 | "preLaunchTask": "npmInstall"
61 | },
62 | {
63 | "name": "Python: Debug Test",
64 | "type": "python",
65 | "request": "launch",
66 | "presentation": { "hidden": true },
67 | "program": "${file}",
68 | "purpose": ["debug-test"],
69 | "justMyCode": true,
70 | "preLaunchTask": "testSetup"
71 | }
72 | ],
73 | "inputs": [
74 | {
75 | "id": "djangoManage",
76 | "type": "promptString",
77 | "description": "Django admin commands.",
78 | "default": "migrate"
79 | }
80 | ]
81 | }
82 |
--------------------------------------------------------------------------------
/template/[[project_name]]/static_source/js/forms/common.ts:
--------------------------------------------------------------------------------
1 | declare global {
2 | interface Element {
3 | active: boolean;
4 | }
5 | }
6 |
7 | function getInput(component: Element): HTMLInputElement | HTMLTextAreaElement | null {
8 | if (component.matches("input, textarea")) {
9 | return component as HTMLInputElement;
10 | } else if (component.querySelector("input, textarea")) {
11 | return component.querySelector("input, textarea") as HTMLInputElement;
12 | }
13 | return null;
14 | }
15 |
16 | function updateFlag(this: HTMLElement & { $el: Element }, e: Event) {
17 | const currentInput: HTMLInputElement | HTMLTextAreaElement | null = getInput(this.$el);
18 |
19 | if (!currentInput) {
20 | console.warn("alpine input attached to something that isn't an input");
21 | return;
22 | }
23 |
24 | switch (e.type) {
25 | case "focus":
26 | case "input":
27 | this.active = true;
28 | break;
29 | case "blur":
30 | if (!currentInput.value) {
31 | this.active = false;
32 | } else {
33 | this.active = true;
34 | }
35 | break;
36 | default:
37 | }
38 |
39 | if (currentInput.classList.contains("autofilled")) {
40 | currentInput.classList.remove("autofilled");
41 | }
42 | };
43 |
44 | // eslint-disable-next-line @typescript-eslint/no-explicit-any
45 | export default function inputListener(this:any) {
46 | const currentComponent = this.$el as HTMLInputElement;
47 | const currentInput = getInput(currentComponent);
48 | if (!currentInput) {
49 | return;
50 | }
51 |
52 | // Each of these events can have a different effect on the active state of the input.
53 | ["blur", "focus", "input"].forEach((eventName) => {
54 | currentInput.addEventListener(eventName, updateFlag.bind(this));
55 | });
56 |
57 | // We're using the animationstart event to detect when the browser has autofilled
58 | currentInput.addEventListener("animationstart", (e: Event) => {
59 | const { animationName } = e as AnimationEvent;
60 | if (!animationName) {
61 | return;
62 | }
63 | switch (animationName) {
64 | case "autofill-start":
65 | this.active = true;
66 | currentInput.classList.add("autofilled");
67 | break;
68 | case "autofill-cancel":
69 | if (document.activeElement === currentInput) {
70 | this.active = true;
71 | } else if (this.value === "") {
72 | this.active = false;
73 | }
74 | if (!currentInput.value) {
75 | currentInput.classList.remove("autofilled");
76 | }
77 | break;
78 | default:
79 | }
80 | });
81 | }
82 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/button/button.py:
--------------------------------------------------------------------------------
1 | from django_components import Component, register
2 |
3 |
4 | @register("button")
5 | class Button(Component):
6 | """
7 | Button component with HTMX support.
8 |
9 | Colors:
10 | - primary: Main action color
11 | - secondary: Less prominent actions
12 | Sizes:
13 | - sm: Small buttons (px-3 py-1.5 text-sm)
14 | - md: Medium buttons (px-4 py-2 text-base) [default]
15 | - lg: Large buttons (px-5 py-2.5 text-lg)
16 | Variants:
17 | - normal: Solid background color [default]
18 | - outline: Bordered with transparent background
19 | Slots:
20 | - content (required): Main button text
21 | - loading: Custom loading indicator for HTMX requests
22 |
23 | Usage:
24 | Basic:
25 | {% component "button" %}
26 | Click Me
27 | {% endcomponent %}
28 |
29 | With Icons:
30 | {% component "button" color="secondary" %}
31 | {% heroicon_mini "user" %}
32 | Profile
33 | {% heroicon_mini "arrow-right" %}
34 | {% endcomponent %}
35 |
36 | Outline Variant:
37 | {% component "button" variant="outline" %}
38 | Secondary Action
39 | {% endcomponent %}
40 |
41 | HTMX Integration:
42 | {% component "button"
43 | attrs:hx-post="{% url 'save'%}"
44 | attrs:hx-target="#result"
45 | %}
46 | Save
47 | {% endcomponent %}
48 | """
49 |
50 | template_name = "button.html"
51 |
52 | def get_context_data(
53 | self,
54 | variant: str = "normal",
55 | color: str = "primary",
56 | size: str = "md",
57 | disabled: bool = False,
58 | attrs: dict[str, str] | None = None,
59 | link: str = "",
60 | target: str = "",
61 | ):
62 | if attrs is None:
63 | attrs = {}
64 |
65 | # Build base classes
66 | classes = [
67 | "btn",
68 | f"btn-{size}",
69 | f"btn-{color}",
70 | ]
71 |
72 | if variant == "outline":
73 | classes.append("btn-outline")
74 |
75 | attrs["class"] = f"{' '.join(classes)} {attrs.get('class', '')}".strip()
76 |
77 | # Check for HTMX usage
78 | is_htmx = any(k.startswith("hx-") for k in attrs)
79 |
80 | # Handle disabled state
81 | if disabled:
82 | attrs["disabled"] = True
83 | attrs["aria-disabled"] = "true"
84 | attrs["class"] += " disabled"
85 |
86 | return {
87 | "attrs": attrs,
88 | "is_htmx": is_htmx,
89 | }
90 |
--------------------------------------------------------------------------------
/todo.txt:
--------------------------------------------------------------------------------
1 | fix silk/debug toolbar profiling
2 | https://github.com/django-commons/django-debug-toolbar/issues/1875
3 | https://github.com/jazzband/django-silk/issues/682
4 |
5 | swap cachealot for cacheops
6 |
7 | Make sure redis caching is configured bestly https://github.com/sebleier/django-redis-cache
8 | setup robots.txt and configure that to be part of django
9 | structlog
10 | Hijack
11 |
12 |
13 |
14 | **DJANGO
15 | set config up with
16 | https://github.com/rochacbruno/dynaconf
17 |
18 | Figure out html emails
19 | - https://github.com/peterbe/premailer
20 | - https://github.com/sunscrapers/django-templated-mail
21 |
22 | Get celery setup
23 | - https://github.com/pmclanahan/django-celery-email
24 |
25 | install
26 |
27 |
28 |
29 | next-boost looks nice
30 | https://github.com/rjyo/next-boost
31 |
32 |
33 | ** Documentation:
34 | Authentication
35 | - same subdomain cookie for same machine
36 | - domain cookie for different machines, same domain (must not be on https://publicsuffix.org/list/public_suffix_list.dat)
37 | - jwt for different domains.
38 |
39 |
40 |
41 | {{ foo:bar}} sets a dictionary in react code but is also a variable in jinja - look into changing jinja delimiter to something illegal in js
42 |
43 |
44 |
45 | documentation notes:
46 | Security
47 |
48 | - http only cookie
49 |
50 |
51 |
52 | mention that you need to use python3.8 to manage.py on prod
53 |
54 |
55 | Truly Static assets - where do they live
56 | - Django - easier to put a cdn in front of them.
57 | Get cdn configured with next and django
58 | https://nextjs.org/docs/api-reference/next.config.js/cdn-support-with-asset-prefix
59 |
60 | fix security issues from:
61 | https://securityheaders.com/?q=https%3A%2F%2Flightmatter-sampleapp.herokuapp.com%2F&followRedirects=on
62 |
63 | Better jest testing:
64 | https://github.com/testing-library/jest-dom
65 |
66 |
67 | cypress testing
68 | https://github.com/cypress-io/cypress-example-recipes
69 | - https://github.com/bahmutov/cypress-select-tests
70 | - get client side mock working w/ mirage, but not enabled when running tests through django
71 | - move nextjs server start into a once per class thing vs once per test in the django test case
72 | - figure out how to enforce new build of nextjs on running django tests
73 | - https://github.com/svish/cypress-hmr-restarter#readme for interactive testing
74 | - https://stackoverflow.com/questions/52231111/re-run-cypress-tests-in-gui-when-webpack-dev-server-causes-page-reload
75 |
76 |
77 | Sentry - Get consolidated error report for frontend and backend
78 | https://nextjs.org/docs/advanced-features/measuring-performance#sending-results-to-analytics
79 | https://github.com/zeit/next.js/discussions/12913 -- get error page working
80 |
--------------------------------------------------------------------------------
/template/[[project_name]]/static_source/js/test/links.test.ts:
--------------------------------------------------------------------------------
1 | import { beforeAll, describe, expect, it } from "vitest";
2 | import linksInit, { isCurrentPage, isExternalLink } from "../links";
3 |
4 | const mockAnchor = (href: string) => ({ href } as HTMLAnchorElement);
5 |
6 | describe("links", () => {
7 | beforeAll(() => {
8 | window.location.href = "https://test.com/example/";
9 | });
10 | it("isExternalLink", () => {
11 | // internal links
12 | expect(isExternalLink(mockAnchor(""))).toBe(false);
13 | expect(isExternalLink(mockAnchor("https://test.com/a#foo"))).toBe(false);
14 | expect(isExternalLink(mockAnchor("/newpage"))).toBe(false);
15 | expect(isExternalLink(mockAnchor("#anchor-ref"))).toBe(false);
16 | expect(isExternalLink(mockAnchor("?foo=bar"))).toBe(false);
17 | expect(isExternalLink(mockAnchor("tel:2013334444"))).toBe(false);
18 | expect(isExternalLink(mockAnchor("mailto:example@test.com"))).toBe(false);
19 | expect(isExternalLink(mockAnchor("https://test.com"))).toBe(false);
20 |
21 | // external links
22 | expect(isExternalLink(mockAnchor("https://example.com"))).toBe(true);
23 | expect(isExternalLink(mockAnchor("https://example.com/#anchor-ref"))).toBe(true);
24 | expect(isExternalLink(mockAnchor("ftp://test.com"))).toBe(true);
25 | });
26 |
27 | it("isCurrentPage", () => {
28 | // same page
29 | expect(isCurrentPage(mockAnchor("https://test.com/example/"))).toBe(true);
30 | expect(isCurrentPage(mockAnchor("/example/#anchor-ref"))).toBe(true);
31 | expect(isCurrentPage(mockAnchor("https://test.com/example/#anchor-ref"))).toBe(true);
32 | // diff page
33 | expect(isCurrentPage(mockAnchor("https://test.com"))).toBe(false); // needs trailing slash
34 | expect(isCurrentPage(mockAnchor("https://example.com/"))).toBe(false); // other domain
35 | expect(isCurrentPage(mockAnchor("https://test.com/otherpage"))).toBe(false); // other page on same domain
36 | });
37 |
38 | it("linksInit", () => {
39 | document.body.innerHTML = `
40 | `_ for end-to-end testing. This replaces the default Django tests using unittest.
32 |
33 | Django tests can be run by running:
34 |
35 | .. code-block:: console
36 |
37 | $ ./manage.py test
38 |
39 |
40 | .. warning::
41 | When doing one of the following, be sure to build Vite assets before running tests:
42 |
43 | * Initializing the project manually
44 | * Adding a new Vite asset (see :ref:`new_vite_assets`)
45 |
46 | To build the assets run:
47 |
48 | .. code-block:: console
49 |
50 | $ npm run build
51 |
52 | If you don't run this command before tests run, some tests may fail even if they would
53 | normally pass.
54 |
55 | Pytest
56 | ******
57 |
58 | While pytest is backwards-compatible with unittest, there are some key differences that implementers need to understand. If you're new to pytest in Django or playwright testing, reviewing the documentation for these libraries is well worth the time.
59 |
60 |
61 | Playwright
62 | **********
63 |
64 | `Playwright `_ feature, which allows you to perform actions in the browser and have Playwright generate the code to perform those actions automatically.
67 |
68 | Rarely is codegen's generated code production ready immediately after recording, but it will get you most of the way through your end-to-end testing.
69 |
70 | `Coverage.py `_ can come in handy here in ensuring that the tests you write cover all of the code you write.
71 |
--------------------------------------------------------------------------------
/template/tailwind.config.js.jinja:
--------------------------------------------------------------------------------
1 | const plugin = require('tailwindcss/plugin');
2 |
3 | module.exports = {
4 | corePlugins: {
5 | preflight: false, //manually import this in app.css
6 | },
7 | content: [
8 | './[[project_name]]/static_source/**/*.html',
9 | './[[project_name]]/static_source/**/*.js',
10 | './[[project_name]]/static_source/**/*.scss',
11 | './[[project_name]]/static_source/**/*.sass',
12 | './[[project_name]]/templates/**/*.html',
13 | './[[project_name]]/components/**/*.html',
14 | './[[project_name]]/components/**/*.svg',
15 | './[[project_name]]/components/**/*.py',
16 |
17 | ],
18 | theme: {
19 | extend: {
20 | colors: {
21 | primary: {
22 | DEFAULT: "var(--primary)",
23 | focus: 'var(--primary-focus)',
24 | content: 'var(--primary-content)'
25 | },
26 | secondary: {
27 | DEFAULT: 'var(--secondary)',
28 | focus: 'var(--secondary-focus)',
29 | content: 'var(--secondary-content)'
30 | },
31 | accent: {
32 | DEFAULT: 'var(--accent)',
33 | 'focus': 'var(--accent-focus)',
34 | 'content': 'var(--accent-content)'
35 | },
36 | neutral: {
37 | '100': '#F3F6FA',
38 | '200': '#E5E7EB',
39 | '300': '#D1D5DB',
40 | '400': '#9CA3AF',
41 | '500': '#6B7280',
42 | '600': '#4B5563',
43 | '700': '#374151',
44 | '800': '#1F2937',
45 | '900': '#111827',
46 | },
47 | debug: {
48 | DEFAULT: 'var(--info)',
49 | 'focus': 'var(--info-focus)',
50 | 'content': 'var(--info-content)'
51 | },
52 | info: {
53 | DEFAULT: 'var(--info)',
54 | 'focus': 'var(--info-focus)',
55 | 'content': 'var(--info-content)'
56 | },
57 | success: {
58 | DEFAULT: 'var(--success)',
59 | 'focus': 'var(--success-focus)',
60 | 'content':'var(--success-content)',
61 | },
62 | warning: {
63 | DEFAULT: 'var(--warning)',
64 | 'focus': 'var(--warning-focus)',
65 | 'content': 'var(--warning-content)'
66 | },
67 | error: {
68 | DEFAULT: 'var(--error)',
69 | 'focus': 'var(--error-focus)',
70 | 'content': 'var(--error-content)'
71 | },
72 | }
73 | },
74 | },
75 | plugins: [
76 | plugin(function({ addVariant }) {
77 | // https://www.crocodile.dev/blog/css-transitions-with-tailwind-and-htmx
78 | addVariant('htmx-settling', ['&.htmx-settling', '.htmx-settling &']);
79 | addVariant('htmx-request', ['&.htmx-request', '.htmx-request &']);
80 | addVariant('htmx-swapping', ['&.htmx-swapping', '.htmx-swapping &']);
81 | addVariant('htmx-added', ['&.htmx-added', '.htmx-added &']);
82 | }),
83 | require('@tailwindcss/forms'),
84 | ],
85 | }
86 |
--------------------------------------------------------------------------------
/scripts/mac_intel_install.sh:
--------------------------------------------------------------------------------
1 | #!/bin/zsh
2 | set -e
3 | # The purpose of the prefix is to give an indication of the point
4 | # of execution of this script, so that if something breaks it's easier
5 | # to see where that broke.
6 | prefix="[LM Install Script] "
7 |
8 | # Credit, Taken from: https://stackoverflow.com/a/34389425
9 | # Installs homebrew if it does not exist, or updates it if it does.
10 | which -s brew
11 | if [[ $? != 0 ]] ; then
12 | echo "${prefix}Installing homebrew"
13 | ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
14 | else
15 | echo "${prefix}Updating homebrew"
16 | brew update
17 | fi
18 |
19 | echo "${prefix}Installing node"
20 | brew install node
21 |
22 | echo "${prefix}Installing node version manager (nvm)"
23 | brew install nvm
24 |
25 | echo "${prefix}Installing pyenv"
26 | brew install pyenv
27 |
28 | echo "${prefix}Attemping to change pyenv version to 3.11.1"
29 | pyenv install 3.11.1
30 | pyenv global 3.11.1
31 |
32 | echo "${prefix}Installing git"
33 | brew install git
34 |
35 | echo "${prefix}Installing direnv"
36 | brew install direnv
37 |
38 | echo "${prefix}Installing postgres"
39 | brew install postgresql
40 |
41 | echo "${prefix}Installing libpq"
42 | brew install libpq
43 |
44 | echo "${prefix}Installing watchman"
45 | brew install watchman
46 |
47 | echo "${prefix}Adding pyenv, direnv, poetry and path config to .zshrc"
48 |
49 | echo "# START LM 3.0 Configuration" >> ~/.zshrc
50 | echo "NVM_DIR=~/.nvm" >> ~/.zshrc
51 | echo "eval \"source \$(brew --prefix nvm)/nvm.sh\"" >> ~/.zshrc
52 | echo "eval \"\$(pyenv init --path)\"" >> ~/.zshrc
53 | echo "eval \"\$(pyenv init -)\"" >> ~/.zshrc
54 | echo "eval \"\$(direnv hook zsh)\"" >> ~/.zshrc
55 | echo "export WORKON_HOME=\"~/.virtualenvs\"" >> ~/.zshrc
56 | echo "export PATH=\"\$HOME/.local/bin:\$PATH\"" >> ~/.zshrc
57 |
58 | echo "${prefix}Reloading zsh"
59 | source ~/.zshrc
60 |
61 | echo "${prefix}Attempting to change nvm version to v16.14.0(default)"
62 | nvm install v16.14.0
63 | nvm alias default v16.14.0
64 | nvm use default
65 |
66 | echo "${prefix}Attempting to install poetry"
67 | curl -sSL https://install.python-poetry.org | python3 -
68 |
69 | echo "# END LM 3.0 Configuration" >> ~/.zshrc
70 |
71 | echo "${prefix}Reloading zsh"
72 | source ~/.zshrc
73 |
74 | echo "${prefix}Creating default DB for postgres"
75 |
76 | db_name=$(whoami)
77 |
78 | if psql -lqt | cut -d \| -f 1 | grep -qw "${db_name}"; then
79 | echo "${prefix}Database ${db_name} already exists, skipping creation."
80 | else
81 | echo "${prefix}Database ${db_name} does not exist, creating."
82 | createdb "${db_name}"
83 | fi
84 |
85 | echo "Provided everything in this script executed without error"
86 | echo "You should now be setup"
87 | echo "You should check your ~/.zshrc"
88 | echo "Important: Now that you have completed the fresh machine setup, you should begin to setup the project."
89 | echo "If you are in an existing project, that is! You can do this with /scripts/setup_existing_project.sh"
90 |
--------------------------------------------------------------------------------
/template/[[project_name]]/components/svg/slack.svg:
--------------------------------------------------------------------------------
1 |
2 |
6 | Slack
7 |
8 |
21 |
22 |
23 |
--------------------------------------------------------------------------------
/template/[[project_name]]/templates/header/mobile_menu.html:
--------------------------------------------------------------------------------
1 | {% if request %}
2 |
51 | {% endif %}
52 |
--------------------------------------------------------------------------------
/template/render.yaml.jinja:
--------------------------------------------------------------------------------
1 | previewsEnabled: true
2 | previewsExpireAfterDays: 5
3 | services:
4 | - type: web
5 | name: [[project_name]]
6 | env: python
7 | previewPlan: starter
8 | healthCheckPath: /
9 | buildCommand: "./build.sh"
10 | startCommand: poetry run gunicorn -c gunicorn.conf.py
11 | envVars:
12 | - key: PYTHON_VERSION
13 | value: 3.11.1
14 | - fromGroup: sentry
15 | - key: SECRET_KEY
16 | generateValue: true
17 | - key: DJANGO_SETTINGS_MODULE
18 | value: "[[project_name]].config.settings.prod"
19 | - key: DJANGO_ALLOWED_HOSTS
20 | fromService:
21 | type: web
22 | envVarKey: RENDER_EXTERNAL_HOSTNAME
23 | name: [[project_name]]
24 | - key: DJANGO_DEBUG
25 | value: false
26 | - key: DATABASE_URL
27 | fromDatabase:
28 | name: [[project_name]]-db
29 | property: connectionString
30 | - key: SENTRY_ENVIRONMENT
31 | fromService:
32 | type: web
33 | envVarKey: RENDER_SERVICE_NAME
34 | name: [[project_name]]
35 | - key: SENTRY_RELEASE
36 | fromService:
37 | type: web
38 | envVarKey: RENDER_GIT_COMMIT
39 | name: [[project_name]]
40 | - key: BUCKET_NAME
41 | value: [[project_name]]
42 | - key: AWS_ACCESS_KEY_ID
43 | fromService:
44 | type: web
45 | envVarKey: MINIO_ROOT_USER
46 | name: minio
47 | - key: AWS_SECRET_ACCESS_KEY
48 | fromService:
49 | type: web
50 | envVarKey: MINIO_ROOT_PASSWORD
51 | name: minio
52 | - key: AWS_ENDPOINT_URL_S3
53 | fromService:
54 | type: web
55 | envVarKey: RENDER_EXTERNAL_URL
56 | name: minio
57 | - key: REDIS_HOST
58 | fromService:
59 | name: redis
60 | type: pserv
61 | property: host # available properties are listed below
62 | - key: REDIS_PORT
63 | fromService:
64 | name: redis
65 | type: pserv
66 | property: port
67 |
68 | - type: web
69 | name: minio
70 | healthCheckPath: /minio/health/live
71 | env: docker
72 | dockerfilePath: ./compose/prod/minio/Dockerfile
73 | dockerContext: ./compose/prod/minio/
74 | disk:
75 | name: data
76 | mountPath: /data
77 | sizeGB: 10
78 | envVars:
79 | - key: MINIO_ROOT_USER
80 | generateValue: true
81 | - key: MINIO_ROOT_PASSWORD
82 | generateValue: true
83 | - key: PORT
84 | value: 9000
85 |
86 | - type: pserv
87 | name: redis
88 | dockerfilePath: ./compose/prod/redis/Dockerfile
89 | dockerContext: ./compose/prod/redis
90 | env: docker
91 | disk:
92 | name: data
93 | mountPath: /var/lib/redis
94 | sizeGB: 10
95 |
96 |
97 | databases:
98 | - name: [[project_name]]-db
99 | previewPlan: starter
100 | databaseName: [[project_name]] # optional (Render may add a suffix)
101 | ipAllowList: [] # optional (defaults to allow all)
102 |
103 | envVarGroups:
104 | - name: sentry
105 | envVars:
106 | - key: SENTRY_DSN
107 | sync: false
108 | - key: SENTRY_PROJECT
109 | value: [[project_name]]
110 |
--------------------------------------------------------------------------------
/template/.github/workflows/django_ci.yml.jinja:
--------------------------------------------------------------------------------
1 | name: Django CI
2 | on:
3 | pull_request:
4 | push:
5 | branches:
6 | - master
7 | - develop
8 |
9 | concurrency:
10 | group: ${{ github.workflow }}-${{ github.ref }}
11 | cancel-in-progress: true
12 |
13 | jobs:
14 | precommit:
15 | name: Precommit linting
16 | runs-on: ubuntu-latest
17 | steps:
18 | - uses: actions/checkout@v4
19 | - uses: actions/cache@v4
20 | with:
21 | path: |
22 | ~/.cache/pre-commit
23 | node_modules
24 | key: precommit-${{ runner.os }}-${{ hashFiles('.pre-commit-config.yaml', '**/package-lock.json') }}
25 | restore-keys: |
26 | precommit-${{ runner.os }}-
27 |
28 | - uses: jdx/mise-action@v2
29 | - run: npm install
30 | - run: mise pre-commit --all-files --color=always ${{ inputs.extra_args }}
31 |
32 | test:
33 | name: Django CI
34 | runs-on: ubuntu-latest
35 | env:
36 | UV_CACHE_DIR: /tmp/.uv-cache
37 | MISE_ENV: ci
38 |
39 | steps:
40 | - uses: actions/checkout@v4
41 | - uses: actions/cache@v4
42 | with:
43 | path: |
44 | /tmp/.uv-cache
45 | ~/.cache/ms-playwright
46 | node_modules
47 | key: ${{ runner.os }}-deps-${{ hashFiles('**/uv.lock', '**/package-lock.json') }}
48 | restore-keys: |
49 | ${{ runner.os }}-deps-
50 | - uses: jdx/mise-action@v2
51 | - name: Install env
52 | run: |
53 | mise setup-js
54 | mise uv
55 | mise x -- playwright install chromium
56 |
57 | - name: Run tests
58 | run: mise test-all --cov
59 |
60 | - name: Minimize uv cache
61 | run: mise x -- uv cache prune --ci
62 |
63 |
64 | services:
65 | postgres:
66 | image: postgres:16-alpine
67 | env:
68 | POSTGRES_PASSWORD: postgres
69 |
70 | options: >-
71 | --health-cmd pg_isready
72 | --health-interval 5s
73 | --health-timeout 5s
74 | --health-retries 3
75 | ports:
76 | - 5432:5432
77 |
78 | deploy-master:
79 | name: Deploy to Production
80 | runs-on: ubuntu-latest
81 | if: github.ref == 'refs/heads/master'
82 | needs: [precommit, test]
83 | environment:
84 | name: production
85 | # url: # Optional: URL where your app is deployed
86 | concurrency: deploy-production
87 | steps:
88 | - uses: actions/checkout@v4
89 | - uses: superfly/flyctl-actions/setup-flyctl@master
90 | - run: flyctl deploy --remote-only
91 | env:
92 | FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
93 |
94 | deploy-develop:
95 | name: Deploy to Staging
96 | runs-on: ubuntu-latest
97 | if: github.ref == 'refs/heads/develop'
98 | needs: [precommit, test]
99 | environment:
100 | name: staging
101 | # url: # Optional: URL where your staging app is deployed
102 | concurrency: deploy-staging
103 | steps:
104 | - uses: actions/checkout@v4
105 | - uses: superfly/flyctl-actions/setup-flyctl@master
106 | - run: flyctl deploy --remote-only
107 | env:
108 | FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
109 |
110 |
111 | dependabot_approve:
112 | name: Auto Merge Dependabot prs
113 | if: ${{ github.actor == 'dependabot[bot]' }}
114 | runs-on: ubuntu-latest
115 |
116 | permissions:
117 | pull-requests: write
118 | contents: write
119 | needs: test
120 |
121 | steps:
122 | - uses: dependabot/fetch-metadata@v2
123 | - run: gh pr review --approve "$PR_URL" && gh pr merge --auto --squash "$PR_URL"
124 | env:
125 | PR_URL: ${{github.event.pull_request.html_url}}
126 | GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
127 |
--------------------------------------------------------------------------------
/template/scripts/export_project.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | import html
3 | import os
4 | from fnmatch import fnmatch
5 | from pathlib import Path
6 |
7 | MANUAL_EXCLUDES = {
8 | "uv.lock",
9 | ".pytest_cache",
10 | ".coverage",
11 | ".ruff_cache",
12 | "dist",
13 | "build",
14 | "__pycache__",
15 | "*.pyc",
16 | "node_modules",
17 | "package-lock.json",
18 | ".venv",
19 | ".git",
20 | "static_source/assets/*",
21 | "*.svg",
22 | }
23 |
24 |
25 | def parse_gitignore(gitignore_path: Path) -> set[str]:
26 | if not gitignore_path.exists():
27 | return set()
28 |
29 | patterns = set()
30 | with open(gitignore_path) as f:
31 | for line in f:
32 | line = line.strip()
33 | if not line or line.startswith("#"):
34 | continue
35 |
36 | # Normalize pattern
37 | if line.startswith("/"):
38 | line = line[1:]
39 | if line.endswith("/"):
40 | patterns.add(f"{line}**")
41 | line = line[:-1]
42 |
43 | patterns.add(line)
44 | # Add pattern with and without leading **/ to catch both absolute and relative paths
45 | if not line.startswith("**/"):
46 | patterns.add(f"**/{line}")
47 |
48 | return patterns
49 |
50 |
51 | def should_include(path: Path, gitignore_patterns: set[str], source_root: Path) -> bool:
52 | try:
53 | rel_path = str(path.relative_to(source_root))
54 | except ValueError:
55 | return True
56 |
57 | # Check manual excludes first
58 | for pattern in MANUAL_EXCLUDES:
59 | if fnmatch(rel_path, pattern) or fnmatch(path.name, pattern):
60 | return False
61 |
62 | # Check gitignore patterns using full path
63 | for pattern in gitignore_patterns:
64 | if fnmatch(rel_path, pattern):
65 | return False
66 |
67 | return True
68 |
69 |
70 | def export_project(source_dir: str, output_file: str):
71 | source_path = Path(source_dir).resolve()
72 | gitignore_patterns = parse_gitignore(source_path / ".gitignore")
73 |
74 | with open(output_file, "w", encoding="utf-8") as f:
75 | f.write("\n")
76 |
77 | file_count = 0
78 | for root_dir, dirs, files in os.walk(source_path):
79 | root_path = Path(root_dir)
80 | dirs[:] = [d for d in dirs if should_include(root_path / d, gitignore_patterns, source_path)]
81 |
82 | for file in files:
83 | file_path = root_path / file
84 | if not should_include(file_path, gitignore_patterns, source_path):
85 | continue
86 |
87 | try:
88 | with open(file_path, encoding="utf-8") as src:
89 | content = src.read()
90 |
91 | relative_path = file_path.relative_to(source_path)
92 | f.write(f'\n')
93 | f.write(f"{html.escape(str(relative_path))} \n")
94 | f.write(
95 | f"{html.escape(content)} \n",
96 | )
97 | f.write(" \n")
98 | file_count += 1
99 |
100 | except UnicodeDecodeError:
101 | print(f"Skipping binary file: {file_path}")
102 | continue
103 |
104 | f.write(" ")
105 | print(f"Exported {file_count} files")
106 |
107 |
108 | if __name__ == "__main__":
109 | import argparse
110 |
111 | parser = argparse.ArgumentParser()
112 | parser.add_argument("source", help="Source directory")
113 | parser.add_argument("output", help="Output XML file")
114 | args = parser.parse_args()
115 |
116 | export_project(args.source, args.output)
117 |
--------------------------------------------------------------------------------
/scripts/export_project.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | import html
3 | import os
4 | from fnmatch import fnmatch
5 | from pathlib import Path
6 |
7 | MANUAL_EXCLUDES = {
8 | "uv.lock",
9 | ".pytest_cache",
10 | ".coverage",
11 | ".ruff_cache",
12 | "dist",
13 | "build",
14 | "__pycache__",
15 | "*.pyc",
16 | "node_modules",
17 | "package-lock.json",
18 | ".venv",
19 | ".git",
20 | "static_source/assets/*",
21 | "*.svg",
22 | "docs/*",
23 | "todo.txt",
24 | }
25 |
26 |
27 | def parse_gitignore(gitignore_path: Path) -> set[str]:
28 | if not gitignore_path.exists():
29 | return set()
30 |
31 | patterns = set()
32 | with open(gitignore_path) as f:
33 | for line in f:
34 | line = line.strip()
35 | if not line or line.startswith("#"):
36 | continue
37 |
38 | # Normalize pattern
39 | if line.startswith("/"):
40 | line = line[1:]
41 | if line.endswith("/"):
42 | patterns.add(f"{line}**")
43 | line = line[:-1]
44 |
45 | patterns.add(line)
46 | # Add pattern with and without leading **/ to catch both absolute and relative paths
47 | if not line.startswith("**/"):
48 | patterns.add(f"**/{line}")
49 |
50 | return patterns
51 |
52 |
53 | def should_include(path: Path, gitignore_patterns: set[str], source_root: Path) -> bool:
54 | try:
55 | rel_path = str(path.relative_to(source_root))
56 | except ValueError:
57 | return True
58 |
59 | # Check manual excludes first
60 | for pattern in MANUAL_EXCLUDES:
61 | if fnmatch(rel_path, pattern) or fnmatch(path.name, pattern):
62 | return False
63 |
64 | # Check gitignore patterns using full path
65 | for pattern in gitignore_patterns:
66 | if fnmatch(rel_path, pattern):
67 | return False
68 |
69 | return True
70 |
71 |
72 | def export_project(source_dir: str, output_file: str):
73 | source_path = Path(source_dir).resolve()
74 | gitignore_patterns = parse_gitignore(source_path / ".gitignore")
75 |
76 | with open(output_file, "w", encoding="utf-8") as f:
77 | f.write("\n")
78 |
79 | file_count = 0
80 | for root_dir, dirs, files in os.walk(source_path):
81 | root_path = Path(root_dir)
82 | dirs[:] = [d for d in dirs if should_include(root_path / d, gitignore_patterns, source_path)]
83 |
84 | for file in files:
85 | file_path = root_path / file
86 | if not should_include(file_path, gitignore_patterns, source_path):
87 | continue
88 |
89 | try:
90 | with open(file_path, encoding="utf-8") as src:
91 | content = src.read()
92 |
93 | relative_path = file_path.relative_to(source_path)
94 | f.write(f'\n')
95 | f.write(f"{html.escape(str(relative_path))} \n")
96 | f.write(
97 | f"{html.escape(content)} \n",
98 | )
99 | f.write(" \n")
100 | file_count += 1
101 | print(f"included {file_path}")
102 |
103 | except UnicodeDecodeError:
104 | print(f"Skipping binary file: {file_path}")
105 | continue
106 |
107 | f.write(" ")
108 | print(f"Exported {file_count} files")
109 |
110 |
111 | if __name__ == "__main__":
112 | import argparse
113 |
114 | parser = argparse.ArgumentParser()
115 | parser.add_argument("source", help="Source directory")
116 | parser.add_argument("output", help="Output XML file")
117 | args = parser.parse_args()
118 |
119 | export_project(args.source, args.output)
120 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | static/
2 | *_flymake*
3 | *.\#*
4 | webpack-stats.json
5 |
6 |
7 | # Byte-compiled / optimized / DLL files
8 | __pycache__/
9 | *.py[cod]
10 |
11 | # C extensions
12 | *.so
13 |
14 | # Distribution / packaging
15 | .Python
16 | env/
17 | build/
18 | develop-eggs/
19 | dist/
20 | eggs/
21 | lib/
22 | lib64/
23 | parts/
24 | sdist/
25 | var/
26 | *.egg-info/
27 | .installed.cfg
28 | *.egg
29 |
30 | # environment variables
31 | .env
32 |
33 | # Installer logs
34 | pip-log.txt
35 | pip-delete-this-directory.txt
36 |
37 | # Unit test / coverage reports
38 | .tox/
39 | .coverage
40 | .cache
41 | nosetests.xml
42 | coverage.xml
43 | htmlcov/
44 |
45 |
46 | # Translations
47 | *.mo
48 |
49 | # Mr Developer
50 | .mr.developer.cfg
51 | .project
52 | .pydevproject
53 |
54 | # Rope
55 | .ropeproject
56 |
57 | # Django stuff:
58 | *.log
59 | *.pot
60 |
61 | # Sphinx documentation
62 | docs/_build/
63 |
64 |
65 | #django media folder
66 | media/
67 |
68 | #PYSCSS trash
69 | .sass-cache/
70 | *style.css
71 | *static_source/sass/style.css*
72 |
73 | #VIM
74 | *.swp
75 | ### vim ###
76 | [._]*.s[a-w][a-z]
77 | [._]s[a-w][a-z]
78 | *.un~
79 | Session.vim
80 | .netrwhist
81 | *~
82 |
83 |
84 | # Created by http://www.gitignore.io
85 |
86 | ### Emacs ###
87 | # -*- mode: gitignore; -*-
88 | *~
89 | \#*\#
90 | /.emacs.desktop
91 | /.emacs.desktop.lock
92 | *.elc
93 | auto-save-list
94 | tramp
95 | .\#*
96 |
97 | # Org-mode
98 | .org-id-locations
99 | *_archive
100 |
101 | # flymake-mode
102 | *_flymake.*
103 |
104 | # eshell files
105 | /eshell/history
106 | /eshell/lastdir
107 |
108 | # elpa packages
109 | /elpa/
110 |
111 | # reftex files
112 | *.rel
113 |
114 | # AUCTeX auto folder
115 | /auto/
116 |
117 |
118 | # Created by http://www.gitignore.io
119 |
120 | ### SublimeText ###
121 | # workspace files are user-specific
122 | *.sublime-workspace
123 |
124 | # project files should be checked into the repository, unless a significant
125 | # proportion of contributors will probably not be using SublimeText
126 | # *.sublime-project
127 |
128 | #sftp configuration file
129 | sftp-config.json
130 |
131 |
132 | # Created by http://www.gitignore.io
133 |
134 | ### OSX ###
135 | .DS_Store
136 | .AppleDouble
137 | .LSOverride
138 |
139 | # Icon must end with two \r
140 | Icon
141 |
142 | # mailhog
143 | /node_modules
144 | node/mailhog/mailhog
145 |
146 |
147 | # Thumbnails
148 | ._*
149 |
150 | # Files that might appear on external disk
151 | .Spotlight-V100
152 | .Trashes
153 |
154 | # Directories potentially created on remote AFP share
155 | .AppleDB
156 | .AppleDesktop
157 | Network Trash Folder
158 | Temporary Items
159 | .apdisk
160 |
161 |
162 | # Created by http://www.gitignore.io
163 |
164 | ### Linux ###
165 | *~
166 |
167 | # KDE directory preferences
168 | .directory
169 |
170 |
171 | ### PyCharm ###
172 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm
173 |
174 | *.iml
175 |
176 | ## Directory-based project format:
177 | .idea/
178 | # if you remove the above rule, at least ignore the following:
179 |
180 | # User-specific stuff:
181 | # .idea/workspace.xml
182 | # .idea/tasks.xml
183 | # .idea/dictionaries
184 |
185 | # Sensitive or high-churn files:
186 | # .idea/dataSources.ids
187 | # .idea/dataSources.xml
188 | # .idea/sqlDataSources.xml
189 | # .idea/dynamic.xml
190 | # .idea/uiDesigner.xml
191 |
192 | # Gradle:
193 | # .idea/gradle.xml
194 | # .idea/libraries
195 |
196 | # Mongo Explorer plugin:
197 | # .idea/mongoSettings.xml
198 |
199 | ## File-based project format:
200 | *.ipr
201 | *.iws
202 |
203 | ## Plugin-specific files:
204 |
205 | # IntelliJ
206 | out/
207 |
208 | # mpeltonen/sbt-idea plugin
209 | .idea_modules/
210 |
211 | # JIRA plugin
212 | atlassian-ide-plugin.xml
213 |
214 | # Crashlytics plugin (for Android Studio and IntelliJ)
215 | com_crashlytics_export_strings.xml
216 | crashlytics.properties
217 | crashlytics-build.properties
218 | testapp/
219 |
220 |
221 | # gunicorn pid file
222 | gunicorn.pid
223 | junit.xml
224 |
225 | #yarn stuf
226 | .yarn/*
227 | !.yarn/cache
228 | !.yarn/releases
229 | !.yarn/plugins
230 | !.yarn/sdks
231 | !.yarn/versions
232 |
233 | #project export for ai
234 | output.xml
235 |
236 | #stylelint cache
237 | .stylelintcache
238 |
239 |
240 | .mypy_cache/
241 | TAGS
242 |
--------------------------------------------------------------------------------
8 | 
13 |
14 | 
31 |