Skip to content

Feat: base template setup #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Apr 22, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*.tmp
*.egg-info
static/
!pems/static
__pycache__/
.coverage
.DS_Store
Expand Down
11 changes: 11 additions & 0 deletions pems/core/context_processors.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
"""
The core application: context processors for enriching request context data.
"""

from pems import __version__


def pems_version(request):
"""Context processor adds information about the PeMS application's version."""

return {"pems_version": __version__}
168 changes: 168 additions & 0 deletions pems/core/templates/core/base.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,168 @@
{% load static %}
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Performance Measurement System (PeMS)</title>
<meta name="Author" content="State of California" />
<meta name="Description" content="Caltrans" />
<meta name="Keywords" content="California, government" />
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
<!-- Public Sans font google API -->
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Public+Sans:ital,wght@0,100..900;1,100..900&display=block" />
<!-- State Template CDN CSS -->
<link rel="stylesheet"
href="https://cdn.cdt.ca.gov/cdt/statetemplate/6.4.1/css/cagov.core.css"
integrity="sha256-OGe4kV30/3p8qPhmiORxFvLS/NrPhdifrumYA6W5W5k="
crossorigin="anonymous" />
<link rel="stylesheet"
href="https://cdn.cdt.ca.gov/cdt/statetemplate/6.4.1/css/colortheme-oceanside.css"
integrity="sha256-PC5Yszm8bAjYYFmjeL8EeB8mHo+S4dJbQt4OwA4aTmg="
crossorigin="anonymous" />
<link rel="stylesheet" href="{% static "css/styles.css" %}">
<!-- State Template JavaScript CDN -->
<script src="https://cdn.cdt.ca.gov/cdt/statetemplate/6.4.1/js/cagov.core.js"
integrity="sha256-TOklMoh1iWoUNIVyzn+Wq8bS56lQWa0R8qklisvEALo="
defer
crossorigin="anonymous"></script>
</head>
<body class="primary">
<header role="banner" id="header" class="global-header fixed">
<!-- Utility header structural component -->
<div class="utility-header">
<div class="container">
<div class="flex-row">
<div class="social-media-links">
<div class="header-cagov-logo">
<a href="https://www.ca.gov">
<span class="sr-only">CA.gov</span>
<span class="ca-gov-logo-svg"></span>
</a>
</div>
<p class="official-tag">
<span class="desktop-only">Official website of the</span>
State of California
</p>
</div>
<div class="settings-links">
<a href="https://github.com/compilerla/pems/releases">PeMS {{ pems_version }}</a>
</div>
</div>
</div>
</div>
<!-- header branding with light gray background -->
<div class="section-default">
<div class="branding">
<div class="header-organization-banner">
<a href="{% url 'core:index' %}">
<div class="logo-assets">
<img class="logo-img" width="150" height="26" src="{% static "img/caltranslogo.png" %}" alt="Caltrans official logo" />
<div class="logo-text">
<span class="logo-state">Caltrans</span>
<span class="logo-dept">Performance Measurement System (PeMS)</span>
</div>
</div>
</a>
</div>
</div>
</div>
<!-- mobile navigation controls -->
<div class="mobile-controls">
<span class="mobile-control-group mobile-header-icons">
<!-- Add more mobile controls here. These will be on the right side of the mobile page header section -->
</span>
<div class="mobile-control-group main-nav-icons">
<button id="nav-icon3" type="button" class="mobile-control toggle-menu" aria-expanded="false" aria-controls="navigation">
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span aria-hidden="true"></span>
<span class="sr-only">Menu</span>
</button>
</div>
</div>
<!-- Top Level Navigation Only -->
<div class="navigation-search full-width-nav container">
<div id="head-search" class="search-container featured-search">
<div class="d-block d-lg-none">
<a href="{% url 'core:index' %}" class="drawer-logo-link first-level-link">
<img src="https://cdn.cdt.ca.gov/cdt/cagov/cagov-lockup/cagov-lockup-flag/cagov-lockup-flag-gradient/cagov-lockup-flag-gradient.svg"
alt="CA.gov official logo"
class="drawer-logo mb-4" />
</a>
</div>
</div>
<nav id="navigation" class="main-navigation singlelevel" aria-label="Main navigation">
<ul id="nav_list" class="top-level-nav">
<li class="nav-item">
<a href="{% url 'core:index' %}" class="first-level-link">Home</a>
</li>
<li class="nav-item">
<a href="{% url 'districts:index' %}" class="first-level-link">Districts</a>
</li>
<li class="nav-item">
<a href="" class="first-level-link">Clearinghouse</a>
</li>
<li class="nav-item">
<a href="" class="first-level-link">About</a>
</li>
</ul>
</nav>
</div>
</header>
<div id="main-content" class="main-content">
<div class="container">
<main class="main-primary">
<h1>
{% block headline %}
{% endblock headline %}
</h1>
{% block inner-content %}
{% endblock inner-content %}
</main>
</div>
</div>
<!-- Global Footer -->
<footer id="footer" class="global-footer">
<div class="container">
<div class="d-flex">
<a href="https://www.ca.gov" class="cagov-logo">
<span class="sr-only">CA.gov</span>
<span class="ca-gov-logo-svg"></span>
</a>
<ul class="footer-links">
<li>
<a href="{% url 'core:index' %}">Conditions of use</a>
</li>
<li>
<a href="{% url 'core:index' %}">Privacy policy</a>
</li>
</ul>
<ul class="socialsharer-container">
<li>
<a href="https://github.com/compilerla/pems/">
<span class="ca-gov-icon-github" aria-hidden="true"></span>
<span class="sr-only">GitHub</span>
</a>
</li>
</ul>
</div>
</div>
<!-- Copyright Statement -->
<div class="copyright">
<div class="container text-right">
<span aria-hidden="true">©</span>
<span id="thisyear">
<script>document.getElementById('thisyear').appendChild(document.createTextNode(new Date().getFullYear()))</script>
</span>
State of California
</div>
</div>
<button class="return-top">
<span class="sr-only">Back to top</span>
</button>
</footer>
</body>
</html>
7 changes: 7 additions & 0 deletions pems/core/templates/core/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{% extends "core/base.html" %}
{% block headline %}
Home page
{% endblock headline %}
{% block inner-content %}
<p>This is the home page</p>
{% endblock inner-content %}
9 changes: 9 additions & 0 deletions pems/core/urls.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
from django.urls import path
from django.views.generic import TemplateView

app_name = "core"

# /
urlpatterns = [
path("", TemplateView.as_view(template_name="core/index.html"), name="index"),
]
2 changes: 1 addition & 1 deletion pems/districts/templates/districts/district.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<h1>District {{ district }}</h1>
<p> URL of route: {% url "districts:district" district%} </p>
<p>URL of route: {% url "districts:district" district %}</p>
8 changes: 7 additions & 1 deletion pems/districts/templates/districts/index.html
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
<h1>Districts</h1>
{% extends "core/base.html" %}
{% block headline %}
Districts
{% endblock headline %}
{% block inner-content %}
<p>Districts</p>
{% endblock inner-content %}
19 changes: 18 additions & 1 deletion pems/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ def _filter_empty(ls):
"django.contrib.sessions",
"django.contrib.messages",
"django.contrib.staticfiles",
"pems.core",
"pems.districts",
"pems.streamlit_sample",
]
Expand Down Expand Up @@ -59,6 +60,7 @@ def _filter_empty(ls):
"django.template.context_processors.request",
"django.contrib.auth.context_processors.auth",
"django.contrib.messages.context_processors.messages",
"pems.core.context_processors.pems_version",
],
},
},
Expand Down Expand Up @@ -113,10 +115,25 @@ def _filter_empty(ls):
# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/5.1/howto/static-files/

STATIC_URL = "static/"
STATIC_URL = "/static/"

STATICFILES_DIRS = [os.path.join(BASE_DIR, "pems", "static")]

# use Manifest Static Files Storage by default
STORAGES = {
"default": {
"BACKEND": "django.core.files.storage.FileSystemStorage",
},
"staticfiles": {
"BACKEND": os.environ.get(
"DJANGO_STATICFILES_STORAGE", "django.contrib.staticfiles.storage.ManifestStaticFilesStorage"
)
},
}

STATIC_ROOT = os.path.join(BASE_DIR, "static")


# Default primary key field type
# https://docs.djangoproject.com/en/5.1/ref/settings/#default-auto-field

Expand Down
12 changes: 12 additions & 0 deletions pems/static/css/styles.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
header {
> div.navigation-search {
> div.search-container > div.d-block > a.drawer-logo-link {
outline-offset: -3px;
> img.drawer-logo {
width: 232px;
filter: brightness(0) invert(1);
aspect-ratio: 18/5;
}
}
}
}
Binary file added pems/static/img/caltranslogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions pems/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
from django.urls import include, path

urlpatterns = [
path("", include("pems.core.urls")),
path("admin/", admin.site.urls),
path("districts/", include("pems.districts.urls")),
path("streamlit/", include("pems.streamlit_sample.urls")),
Expand Down
11 changes: 10 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ maintainers = [{ name = "Compiler LLC", email = "dev@compiler.la" }]
dependencies = ["Django==5.1.6", "gunicorn==23.0.0"]

[project.optional-dependencies]
dev = ["black", "flake8", "pre-commit", "setuptools_scm>=8"]
dev = ["black", "djlint", "flake8", "pre-commit", "setuptools_scm>=8"]

test = ["coverage", "pytest", "pytest-django", "pytest-mock", "pytest-socket"]

Expand All @@ -34,6 +34,15 @@ relative_files = true
source = ["pems", "streamlit_app"]
omit = ["streamlit_app/apps/*"]

[tool.djlint]
ignore = "H006,H017,H031"
indent = 2
max_attribute_length = 127
max_line_length = 127
profile = "django"
preserve_blank_lines = true
use_gitignore = true

[tool.pytest.ini_options]
DJANGO_SETTINGS_MODULE = "pems.settings"

Expand Down
Loading