Merge pull request #145 from ImperialCollegeLondon/navbar_ui

adding user info and help page setup

main/templates/main/help.html

@@ -0,0 +1,5 @@
+{% extends "main/base.html" %}
+{% block content %}
+  <h1>Help</h1>
+  <p>This is the help page.</p>
+{% endblock content %}

main/templates/main/navbar.html

@@ -22,6 +22,16 @@
           </li>
         {% endif %}
       </ul>
+      <ul class="navbar-nav">
+        {% if user.is_authenticated %}
+          <li class="nav-item">
+            <a class="nav-link">Welcome: {{ user.username }}</a>
+          </li>
+          <li class="nav-item">
+            <a class="nav-link" href="{% url 'main:help' %}">Help</a>
+          </li>
+        {% endif %}
+      </ul>
     </div>
   </div>
 </nav>

main/urls.py

@@ -8,4 +8,5 @@
 urlpatterns = [
     path("", views.index, name="index"),
     path("accounts/", include("django.contrib.auth.urls")),
+    path("help/", views.HelpView.as_view(), name="help"),
 ]

main/views.py

@@ -3,9 +3,18 @@
 from django.contrib.auth.decorators import login_required
 from django.http import HttpRequest, HttpResponse
 from django.shortcuts import render
+from django.views import View
 
 
 @login_required
 def index(request: HttpRequest) -> HttpResponse:
     """View that renders the index/home page."""
     return render(request=request, template_name="main/index.html")
+
+
+class HelpView(View):
+    """View that renders the help page."""
+
+    def get(self, request: HttpRequest) -> HttpResponse:
+        """Render the help page."""
+        return render(request=request, template_name="main/help.html")

tests/main/test_views.py

@@ -38,3 +38,11 @@ def test_index_view_authenticated(self, auth_client):
             response,
             f'<a href="{reverse("controller:index")}" class="btn btn-secondary">Controller</a>',  # noqa: E501
         )
+
+    def test_help_view(self, auth_client):
+        """Test that the help view is rendered."""
+        response = auth_client.get(reverse("main:help"))
+        assert response.status_code == HTTPStatus.OK
+        assertTemplateUsed(response, "main/help.html")
+        assertContains(response, "<h1>Help</h1>")
+        assertContains(response, "This is the help page.")