Project editor (#319)

* feat: endpoint for eagerly fetching all projects for students/teachers/assistants

* feat: editor for course description and editor, better project overview list

* chore: improved project progressbar, linting

* improvement: skeleton loaders for project list

* chore: better display of HTML description

---------

Co-authored-by: francis <francis.vauterin@ugent.be>

backend/api/migrations/0016_course_excerpt_alter_checkresult_submission_and_more.py

@@ -0,0 +1,35 @@
+# Generated by Django 5.0.4 on 2024-04-15 19:09
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0015_checkresult_remove_extrachecksresult_error_message_and_more'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='course',
+            name='excerpt',
+            field=models.CharField(default='no excerpt provided', max_length=200),
+            preserve_default=False,
+        ),
+        migrations.AlterField(
+            model_name='checkresult',
+            name='submission',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='results', to='api.submission'),
+        ),
+        migrations.AlterField(
+            model_name='extracheckresult',
+            name='extra_check',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='extra_check', to='api.extracheck'),
+        ),
+        migrations.AlterField(
+            model_name='structurecheckresult',
+            name='structure_check',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='structure_check', to='api.structurecheck'),
+        ),
+    ]

backend/api/migrations/0017_merge_20240416_1054.py

@@ -7,6 +7,7 @@ class Migration(migrations.Migration):
 
     dependencies = [
         ('api', '0016_alter_checkresult_submission_and_more'),
+        ('api', '0016_course_excerpt_alter_checkresult_submission_and_more'),
         ('api', '0016_remove_checkresult_is_valid_submission_is_valid_and_more'),
     ]
 

backend/api/models/course.py

@@ -16,6 +16,9 @@ class Course(models.Model):
     # Begin year of the academic year
     academic_startyear = models.IntegerField(blank=False, null=False)
 
+    # The excerpt of the course
+    excerpt = models.CharField(max_length=200, blank=False, null=False)
+
     # The description of the course
     description = models.TextField(blank=True, null=True)
 

backend/api/serializers/course_serializer.py

@@ -1,3 +1,4 @@
+from nh3 import clean
 from django.utils.translation import gettext
 from rest_framework import serializers
 from rest_framework.exceptions import ValidationError
@@ -37,6 +38,11 @@ class CourseSerializer(serializers.ModelSerializer):
         read_only=True
     )
 
+    def validate(self, attrs: dict) -> dict:
+        """Extra custom validation for course serializer"""
+        attrs['description'] = clean(attrs['description'])
+        return attrs
+
     class Meta:
         model = Course
         fields = "__all__"

backend/api/serializers/project_serializer.py

@@ -1,4 +1,5 @@
 from api.logic.check_folder_structure import parse_zip_file
+from nh3 import clean
 from api.models.checks import FileExtension
 from api.models.course import Course
 from api.models.group import Group
@@ -64,6 +65,8 @@ def validate(self, data):
         if "deadline" in data and data["deadline"] < start_date:
             raise ValidationError(gettext("project.errors.deadline_before_start_date"))
 
+        data['description'] = clean(data['description'])
+
         return data
 
     class Meta:

backend/api/tests/test_course.py

@@ -782,6 +782,7 @@ def test_create_course(self):
             data={
                 "name": "Introduction to Computer Science",
                 "academic_startyear": 2022,
+                "excerpt": "Excerpt",
                 "description": "An introductory course on computer science.",
                 "faculty": faculty.id,
             },

backend/pyproject.toml

@@ -29,6 +29,7 @@ django-seed = "^0.3.1"
 django-celery-results = "^2.5.1"
 django-polymorphic = "^3.1.0"
 django-rest-polymorphic = "^0.1.10"
+nh3 = "^0.2.17"
 
 
 [build-system]

backend/setup.sh

@@ -4,7 +4,6 @@ poetry install > /dev/null
 
 echo "Migrating database..."
 python manage.py migrate > /dev/null
-python manage.py migrate django_celery_results > /dev/null
 
 echo "Compiling translations..."
 django-admin compilemessages > /dev/null