Merge pull request #16 from daniviga/cdn

Add cover to consist page and cdn option

.github/workflows/django.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       max-parallel: 2
       matrix:
-        python-version: ['3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11']
 
     steps:
     - uses: actions/checkout@v3

README.md

@@ -49,7 +49,7 @@ It has been developed with:
 
 ## Requirements
 
-- Python 3.8+
+- Python 3.9+
 - A USB port when running Arduino hardware (and adaptors if you have a Mac)
 
 ## Web portal installation

ram/portal/admin.py

@@ -26,6 +26,7 @@ class SiteConfigurationAdmin(SingletonModelAdmin):
                 "classes": ("collapse",),
                 "fields": (
                     "show_version",
+                    "use_cdn",
                     "extra_head",
                 ),
             },

ram/portal/migrations/0015_siteconfiguration_use_cdn.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.1.5 on 2023-01-03 15:01
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("portal", "0014_siteconfiguration_extra_head"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="siteconfiguration",
+            name="use_cdn",
+            field=models.BooleanField(default=True),
+        ),
+    ]

ram/portal/models.py

@@ -35,6 +35,7 @@ class SiteConfiguration(SingletonModel):
     footer = RichTextField(blank=True)
     footer_extended = RichTextField(blank=True)
     show_version = models.BooleanField(default=True)
+    use_cdn = models.BooleanField(default=True)
     extra_head = models.TextField(blank=True)
 
     class Meta:

ram/portal/static/css/main.css

@@ -11,10 +11,6 @@ a.badge, a.badge:hover {
   color: #fff;
 }
 
-.tab-pane {
-  min-height: 300px;
-}
-
 .img-thumbnail {
   padding: 0;
 }

ram/portal/templates/base.html

@@ -13,9 +13,14 @@
     <meta name="author" content="{{ site_conf.site_author }}">
     <meta name="generator" content="Django Framework">
     <title>{% block title %}{{ title }}{% endblock %} - {{ site_conf.site_name }}</title>
+    {% if site_conf.use_cdn %}
     <link href="https://cdn.jsdelivr.net/npm/bootstrap-dark-5@1.1.3/dist/css/bootstrap-nightshade.min.css" rel="stylesheet">
-    <link href="{% static "css/main.css" %}" rel="stylesheet">
     <link href="https://stackpath.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet">
+    {% else %}
+    <link href="{% static "bootstrap-dark-5@1.1.3/dist/css/bootstrap-nightshade.min.css" %}" rel="stylesheet">
+    <link href="{% static "font-awesome/4.7.0/css/font-awesome.min.css" %}" rel="stylesheet">
+    {% endif %}
+    <link href="{% static "css/main.css" %}" rel="stylesheet">
     <style>
       .bd-placeholder-img {
         font-size: 1.125rem;
@@ -49,7 +54,7 @@
             </svg>
             <strong>{{ site_conf.site_name }}</strong>
           </a>
-          <div class="btn-group" role="group" aria-label="Basic example">
+          <div class="btn-group" role="group" aria-label="Login menu">
             {% include 'includes/login.html' %}
             <a id="darkmode-button" class="btn btn-sm btn-outline-dark"><i class="fa fa-moon-o fa-fw d-none d-light-inline" title="Switch to dark mode"></i><i class="fa fa-sun-o fa-fw d-none d-dark-inline" title="Switch to light mode"></i></a>
          </div>
@@ -93,105 +98,24 @@
       </section>
       <div class="album py-4 bg-light">
         <div class="container">
-          <a id="rolling-stock"></a>
-          <div class="row row-cols-1 row-cols-sm-2 row-cols-md-3 g-3">
-            {% block cards %}
-            {% for r in rolling_stock %}
-            <div class="col">
-              <div class="card shadow-sm">
-                {% for i in r.image.all %}
-                {% if forloop.first %}<a href="{{r.get_absolute_url}}"><img src="{{ i.image.url }}" alt="Card image cap"></a>{% endif %}
-                {% endfor %}
-                <div class="card-body">
-                  <p class="card-text" style="position: relative;">
-                    <strong>{{ r }}</strong>
-                    <a class="stretched-link" href="{{ r.get_absolute_url }}"></a>
-                  </p>
-                  {% if r.tags.all %}
-                  <p class="card-text"><small>Tags:</small>
-                    {% for t in r.tags.all %}<a href="{% url 'filtered' _filter="tag" search=t.slug %}" class="badge rounded-pill bg-primary">
-                    {{ t.name }}</a>{# new line is required #}
-                    {% endfor %}
-                  </p>
-                  {% endif %}
-                  <table class="table table-striped">
-                    <thead>
-                      <tr>
-                        <th colspan="2" scope="row">Data</th>
-                      </tr>
-                    </thead>
-                    <tbody>
-                      <tr>
-                        <th width="35%" scope="row">Type</th>
-                        <td>{{ r.rolling_class.type }}</td>
-                      </tr>
-                      <tr>
-                        <th scope="row">Company</th>
-                        <td><abbr title="{{ r.rolling_class.company.extended_name }}">{{ r.rolling_class.company }}</abbr></td>
-                      </tr>
-                      <tr>
-                        <th scope="row">Class</th>
-                        <td>{{ r.rolling_class.identifier }}</td>
-                      </tr>
-                      <tr>
-                        <th scope="row">Road number</th>
-                        <td>{{ r.road_number }}</td>
-                      </tr>
-                      <tr>
-                        <th scope="row">Era</th>
-                        <td>{{ r.era }}</td>
-                      </tr>
-                      <tr>
-                        <th width="35%" scope="row">Manufacturer</th>
-                        <td>{% if r.manufacturer.website %}<a href="{{ r.manufacturer.website }}">{% endif %}{{ r.manufacturer }}{% if r.manufacturer.website %}</a>{% endif %}</th>
-                      </tr>
-                      <tr>
-                        <th scope="row">Scale</th>
-                        <td><a href="{% url 'filtered' _filter="scale" search=r.scale %}"><abbr title="{{ r.scale.ratio }} - {{ r.scale.tracks }}">{{ r.scale }}</abbr></a></td>
-                      </tr>
-                      <tr>
-                        <th scope="row">SKU</th>
-                        <td>{{ r.sku }}</td>
-                      </tr>
-                    </tbody>
-                  </table>
-                  {% if r.decoder %}
-                  <table class="table table-striped">
-                    <thead>
-                      <tr>
-                        <th colspan="2" scope="row">DCC data</th>
-                      </tr>
-                    </thead>
-                    <tbody>
-                      <tr>
-                        <th width="35%" scope="row">Decoder</th>
-                        <td>{{ r.decoder }}</td>
-                      </tr>
-                      <tr>
-                        <th scope="row">Address</th>
-                        <td>{{ r.address }}</td>
-                      </tr>
-                    </tbody>
-                  </table>
-                  {% endif %}
-                  <div class="d-grid gap-2 mb-1 d-md-block">
-                   <a class="btn btn-sm btn-outline-primary" href="{{r.get_absolute_url}}">Show all data</a>
-                    {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% url 'admin:roster_rollingstock_change' r.pk %}">Edit</a>{% endif %}
-                  </div>
-                </div>
-              </div>
-            </div>
-            {% endfor %}
+          {% block carousel %}
+          {% endblock %}
+          <a id="rolling-stock"></a>
+          {% block cards_layout %}
           {% endblock %}
-          </div>
         </div>
         <div class="container">{% block pagination %}{% endblock %}</div>
       </div>
       {% block extra_content %}{% endblock %}
     </main>
     {% include 'includes/footer.html' %}
+    {% if site_conf.use_cdn %}
     <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js"></script>
     <script src="https://cdn.jsdelivr.net/npm/bootstrap-dark-5@1.1.3/dist/js/darkmode.min.js"></script>
+    {% else %}
+    <script src="{% static "bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js" %}"></script>
+    <script src="{% static "bootstrap-dark-5@1.1.3/dist/js/darkmode.min.js" %}"></script>
+    {% endif %}
     <!-- script src="https://cdn.jsdelivr.net/npm/masonry-layout@4.2.2/dist/masonry.pkgd.min.js" integrity="sha384-GNFwBvfVxBkLMJpYMOABq3c+d3KnQxudP/mGPkzpZSTYykLBNsZEnG2D9G/X/+7D" crossorigin="anonymous" async></script -->
     <script>
       document.querySelector("#darkmode-button").onclick = function(e){

ram/portal/templates/cards.html

@@ -0,0 +1,94 @@
+{% extends "base.html" %}
+
+      {% block cards_layout %}
+      <div class="row row-cols-1 row-cols-sm-2 row-cols-md-3 g-3">
+      {% block cards %}
+        {% for r in rolling_stock %}
+        <div class="col">
+          <div class="card shadow-sm">
+            {% for i in r.image.all %}
+            {% if forloop.first %}<a href="{{r.get_absolute_url}}"><img src="{{ i.image.url }}" alt="Card image cap"></a>{% endif %}
+            {% endfor %}
+            <div class="card-body">
+              <p class="card-text" style="position: relative;">
+                <strong>{{ r }}</strong>
+                <a class="stretched-link" href="{{ r.get_absolute_url }}"></a>
+              </p>
+              {% if r.tags.all %}
+              <p class="card-text"><small>Tags:</small>
+                {% for t in r.tags.all %}<a href="{% url 'filtered' _filter="tag" search=t.slug %}" class="badge rounded-pill bg-primary">
+                {{ t.name }}</a>{# new line is required #}
+                {% endfor %}
+              </p>
+              {% endif %}
+              <table class="table table-striped">
+                <thead>
+                  <tr>
+                    <th colspan="2" scope="row">Data</th>
+                  </tr>
+                </thead>
+                <tbody>
+                  <tr>
+                    <th width="35%" scope="row">Type</th>
+                    <td>{{ r.rolling_class.type }}</td>
+                  </tr>
+                  <tr>
+                    <th scope="row">Company</th>
+                    <td><abbr title="{{ r.rolling_class.company.extended_name }}">{{ r.rolling_class.company }}</abbr></td>
+                  </tr>
+                  <tr>
+                    <th scope="row">Class</th>
+                    <td>{{ r.rolling_class.identifier }}</td>
+                  </tr>
+                  <tr>
+                    <th scope="row">Road number</th>
+                    <td>{{ r.road_number }}</td>
+                  </tr>
+                  <tr>
+                    <th scope="row">Era</th>
+                    <td>{{ r.era }}</td>
+                  </tr>
+                  <tr>
+                    <th width="35%" scope="row">Manufacturer</th>
+                    <td>{% if r.manufacturer.website %}<a href="{{ r.manufacturer.website }}">{% endif %}{{ r.manufacturer }}{% if r.manufacturer.website %}</a>{% endif %}</th>
+                  </tr>
+                  <tr>
+                    <th scope="row">Scale</th>
+                    <td><a href="{% url 'filtered' _filter="scale" search=r.scale %}"><abbr title="{{ r.scale.ratio }} - {{ r.scale.tracks }}">{{ r.scale }}</abbr></a></td>
+                  </tr>
+                  <tr>
+                    <th scope="row">SKU</th>
+                    <td>{{ r.sku }}</td>
+                  </tr>
+                </tbody>
+              </table>
+              {% if r.decoder %}
+              <table class="table table-striped">
+                <thead>
+                  <tr>
+                    <th colspan="2" scope="row">DCC data</th>
+                  </tr>
+                </thead>
+                <tbody>
+                  <tr>
+                    <th width="35%" scope="row">Decoder</th>
+                    <td>{{ r.decoder }}</td>
+                  </tr>
+                  <tr>
+                    <th scope="row">Address</th>
+                    <td>{{ r.address }}</td>
+                  </tr>
+                </tbody>
+              </table>
+              {% endif %}
+              <div class="d-grid gap-2 mb-1 d-md-block">
+               <a class="btn btn-sm btn-outline-primary" href="{{r.get_absolute_url}}">Show all data</a>
+                {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% url 'admin:roster_rollingstock_change' r.pk %}">Edit</a>{% endif %}
+              </div>
+            </div>
+          </div>
+        </div>
+        {% endfor %}
+      {% endblock %}
+      </div>
+      {% endblock %}

ram/portal/templates/companies.html

@@ -1,4 +1,4 @@
-{% extends "base.html" %}
+{% extends "cards.html" %}
 
       {% block cards %}
       {% for c in company %}

ram/portal/templates/consist.html

@@ -1,4 +1,4 @@
-{% extends "base.html" %}
+{% extends "cards.html" %}
 
       {% block header %}
       {% if consist.tags.all %}
@@ -10,6 +10,19 @@
       <small class="text-muted">Updated {{ consist.updated_time | date:"M d, Y H:i" }}</small>
       {% endif %}
       {% endblock %}
+      {% block carousel %}
+      {% if consist.image %}
+      <div class="row pb-4">
+        <div id="carouselControls" class="carousel carousel-dark slide" data-bs-ride="carousel">
+          <div class="carousel-inner">
+            <div class="carousel-item active">
+              <img src="{{ consist.image.url }}" class="d-block w-100 rounded img-thumbnail" alt="...">
+            </div>
+          </div>
+        </div>
+      </div>
+      {% endif %}
+      {% endblock %}
       {% block cards %}
       {% for r in rolling_stock %}
       <div class="col">
@@ -141,6 +154,51 @@
       <section class="py-4 text-start container">
         <div class="row">
           <div class="mx-auto">
+            <nav>
+              <div class="nav nav-tabs" id="nav-tab" role="tablist">
+                <button class="nav-link active" id="nav-summary-tab" data-bs-toggle="tab" data-bs-target="#nav-summary" type="button" role="tab" aria-controls="nav-summary" aria-selected="true">Summary</button>
+                {% if consist.notes %}<button class="nav-link" id="nav-notes-tab" data-bs-toggle="tab" data-bs-target="#nav-notes" type="button" role="tab" aria-controls="nav-notes" aria-selected="false">Notes</button>{% endif %}
+               </div>
+            </nav>
+            <div class="tab-content" id="nav-tabContent">
+              <div class="tab-pane fade show active" id="nav-summary" role="tabpanel" aria-labelledby="nav-summary-tab">
+                <table class="table table-striped">
+                  <thead>
+                    <tr>
+                      <th colspan="2" scope="row">Data</th>
+                    </tr>
+                  </thead>
+                  <tbody>
+                    <tr>
+                      <th width="35%" scope="row">Company</th>
+                      <td><abbr title="{{ consist.company.extended_name }}">{{ consist.company }}</abbr></td>
+                    </tr>
+                    <tr>
+                      <th scope="row">Era</th>
+                      <td>{{ consist.era }}</td>
+                    </tr>
+                    <tr>
+                      <th scope="row">Length</th>
+                      <td>{{ rolling_stock | length }}</td>
+                    </tr>
+                  </tbody>
+                </table>
+              </div>
+              <div class="tab-pane fade" id="nav-notes" role="tabpanel" aria-labelledby="nav-notes-tab">
+                <table class="table">
+                  <thead>
+                    <tr>
+                      <th scope="row">Notes</th>
+                    </tr>
+                  </thead>
+                  <tbody>
+                    <tr>
+                      <td>{{ consist.notes | safe }}</td>
+                    </tr>
+                  </tbody>
+                </table>
+              </div>
+            </div>
             <div class="d-grid gap-2 d-md-flex justify-content-md-end">
               {% if request.user.is_staff %}<a class="btn btn-sm btn-outline-danger" href="{% url 'admin:consist_consist_change' consist.pk %}">Edit</a>{% endif %}
             </div>

ram/portal/templates/consists.html

@@ -1,4 +1,4 @@
-{% extends "base.html" %}
+{% extends "cards.html" %}
 
       {% block cards %}
       {% for c in consist %}

ram/portal/templates/home.html

@@ -1,9 +1,8 @@
-{% extends "base.html" %}
+{% extends "cards.html" %}
 
       {% block header %}
         <p class="lead text-muted">{{ site_conf.about | safe }}</p>
       {% endblock %}
-
       {% block pagination %}
       {% if rolling_stock.has_other_pages %}
       <nav aria-label="Page navigation example">

ram/portal/templates/includes/login.html

@@ -1,9 +1,8 @@
       {% if request.user.is_staff %}
-      <div class="dropdown">
       <button class="btn btn-sm btn-outline-dark dropdown-toggle" type="button" id="dropdownMenu2" data-bs-toggle="dropdown" aria-expanded="false">
         Welcome back, <strong>{{ request.user }}</strong>
       </button>
-        <ul class="dropdown-menu dropdown-menu-end" aria-labelledby="dropdownMenu2">
+      <ul class="dropdown-menu" aria-labelledby="dropdownMenu2">
         <li><a class="dropdown-item" href="{% url 'admin:roster_rollingstock_changelist' %}">Rolling stock</a></li>
         <li><a class="dropdown-item" href="{% url 'admin:consist_consist_changelist' %}">Consists</a></li>
         <li><a class="dropdown-item" href="{% url 'admin:app_list' 'metadata' %}">Metadata</a></li>
@@ -15,7 +14,6 @@
         <li><hr class="dropdown-divider"></li>
         <li><a class="dropdown-item text-danger" href="{% url 'admin:logout' %}?next={{ request.path }}">Logout</a></li>
       </ul>
-      </div>
       {% else %}
       <a class="btn btn-sm btn-outline-dark" href="{% url 'admin:login' %}?next={{ request.path }}">Log in</a>
       {% endif %}

ram/portal/templates/rollingstock.html

@@ -10,29 +10,34 @@
         {% endif %}
         <small class="text-muted">Updated {{ rolling_stock.updated_time | date:"M d, Y H:i" }}</small>
         {% endblock %}
-        {% block cards %}
+        {% block carousel %}
+        <div class="row">
+          <div id="carouselControls" class="carousel carousel-dark slide" data-bs-ride="carousel" data-bs-interval="10000">
+            <div class="carousel-inner">
               {% for t in rolling_stock.image.all %}
-        <div class="col">
-            <a href="" data-bs-toggle="modal" data-bs-target="#pictureModal{{ forloop.counter }}"><img class="img-thumbnail" src="{{ t.image.url }}" alt="Rolling stock image"></a>
-        </div>
-        <!-- Modal -->
-        <div class="modal fade" id="pictureModal{{ forloop.counter }}" tabindex="-1" aria-labelledby="pictureModalLabel{{ forloop.counter }}" aria-hidden="true">
-          <div class="modal-dialog modal-lg">
-            <div class="modal-content">
-              <div class="modal-header">
-                <h5 class="modal-title" id="pictureModalLabel{{ forloop.counter }}">{{ rolling_stock }}</h5>
-                <button type="button" class="btn-close" data-bs-dismiss="modal" aria-label="Close"></button>
-              </div>
-              <div class="modal-body text-center">
-                  <img class="rounded img-fluid" src="{{ t.image.url }}" alt="Rolling stock image">
-              </div>
-              <div class="modal-footer">
-                <button type="button" class="btn btn-secondary" data-bs-dismiss="modal">Close</button>
-              </div>
-            </div>
-          </div>
+              {% if forloop.first %}
+              <div class="carousel-item active">
+              {% else %}
+              <div class="carousel-item">
+              {% endif %}
+                <img src="{{ t.image.url }}" class="d-block w-100 rounded img-thumbnail" alt="...">
               </div>
               {% endfor %}
+            </div>
+            {% if rolling_stock.image.count > 1 %}
+            <button class="carousel-control-prev" type="button" data-bs-target="#carouselControls" data-bs-slide="prev">
+              <span class="carousel-control-prev-icon" aria-hidden="true"></span>
+              <span class="visually-hidden">Previous</span>
+            </button>
+            <button class="carousel-control-next" type="button" data-bs-target="#carouselControls" data-bs-slide="next">
+              <span class="carousel-control-next-icon" aria-hidden="true"></span>
+              <span class="visually-hidden">Next</span>
+            </button>
+            {% endif %}
+          </div>
+        </div>
+        {% endblock %}
+        {% block cards %}
         {% endblock %}
         {% block extra_content %}
         <section class="py-4 text-start container">
@@ -263,7 +268,18 @@
                   </table>
                 </div>
                 <div class="tab-pane fade" id="nav-notes" role="tabpanel" aria-labelledby="nav-notes-tab">
-                  {{ rolling_stock.notes | safe }}
+                  <table class="table">
+                    <thead>
+                      <tr>
+                        <th scope="row">Notes</th>
+                      </tr>
+                    </thead>
+                    <tbody>
+                      <tr>
+                        <td>{{ rolling_stock.notes | safe }}</td>
+                      </tr>
+                    </tbody>
+                  </table>
                 </div>
                 <div class="tab-pane fade" id="nav-documents" role="tabpanel" aria-labelledby="nav-documents-tab">
                   <table class="table table-striped">

ram/portal/templates/scales.html

@@ -1,4 +1,4 @@
-{% extends "base.html" %}
+{% extends "cards.html" %}
 
       {% block cards %}
       {% for s in scale %}

ram/portal/templates/search.html

@@ -1,4 +1,4 @@
-{% extends "base.html" %}
+{% extends "cards.html" %}
 
       {% block header %}
         <p class="lead text-muted">Results found: {{ matches }}</p>

ram/portal/views.py

@@ -170,7 +170,7 @@ class GetRollingStock(View):
 
         return render(
             request,
-            "page.html",
+            "rollingstock.html",
             {
                 "title": rolling_stock,
                 "rolling_stock": rolling_stock,

ram/ram/__init__.py

@@ -1,4 +1,4 @@
 from ram.utils import git_suffix
 
-__version__ = "0.0.24"
+__version__ = "0.0.26"
 __version__ += git_suffix(__file__)