Merge pull request #189 from 2077-Collective/main

main to staging sync

Author: happychuks

.github/workflows/lock-main.yaml

@@ -1,4 +1,4 @@
-name: Restrict Merge to Main
+name: Merge to Main
 
 on:
   pull_request:
@@ -8,11 +8,3 @@ on:
 jobs:
   check_source_branch:
     runs-on: ubuntu-latest
-
-    steps:
-      - name: Check Source Branch
-        run: |
-          if [ "${{ github.event.pull_request.head.ref  }}" != "staging"  ]; then
-            echo "PRs to main branch must come from staging branch only."
-            exit 1
-          fi

README.md

@@ -2,7 +2,7 @@
 
 # 2077 Collective
 
-Content management system written in Python(Django) and React.js
+Content management system written in Python(Django) and Sveltekit
 
 ## Project Architecture
 

server/apps/research/admin/article_admin.py

@@ -18,11 +18,12 @@ class ArticleAdmin(admin.ModelAdmin):
     form = ArticleForm
     fieldsets = [
         ('Article Details', {'fields': ['title', 'slug', 'authors', 'acknowledgement', 'categories', 'thumb', 'content', 'summary', 'status', 'scheduled_publish_time']}),
+        ('Sponsorship Details', {'fields': ['is_sponsored', 'sponsor_color', 'sponsor_text_color']}),
     ]
     list_display = ('title', 'display_authors', 'status', 'views', 'display_categories', 'min_read', 'created_at', 'scheduled_publish_time')
     search_fields = ('title', 'authors__user__username', 'authors__twitter_username', 'content')
     list_per_page = 25
-    list_filter = ('authors', 'status', 'categories', 'created_at')
+    list_filter = ('authors', 'status', 'categories', 'created_at', 'is_sponsored')
     readonly_fields = ('views',)
     list_editable = ('status',)
 

server/apps/research/migrations/0005_article_table_of_contents.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.0.8 on 2024-10-14 21:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('research', '0004_alter_article_authors'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='article',
+            name='table_of_contents',
+            field=models.JSONField(blank=True, default=list),
+        ),
+    ]

server/apps/research/migrations/0006_article_is_sponsored_article_sponsor_color_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.0.8 on 2024-10-23 08:16
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('research', '0005_article_table_of_contents'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='article',
+            name='is_sponsored',
+            field=models.BooleanField(default=False),
+        ),
+        migrations.AddField(
+            model_name='article',
+            name='sponsor_color',
+            field=models.CharField(default='#FF0420', max_length=7),
+        ),
+        migrations.AddField(
+            model_name='article',
+            name='sponsor_text_color',
+            field=models.CharField(default='#000000', max_length=7),
+        ),
+    ]

server/apps/research/migrations/0007_alter_article_sponsor_color_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.0.8 on 2024-10-23 10:50
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('research', '0006_article_is_sponsored_article_sponsor_color_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='article',
+            name='sponsor_color',
+            field=models.CharField(default='#FF0420 !important', max_length=7),
+        ),
+        migrations.AlterField(
+            model_name='article',
+            name='sponsor_text_color',
+            field=models.CharField(default='#000000 !important', max_length=7),
+        ),
+    ]

server/apps/research/migrations/0008_alter_article_sponsor_color_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.0.8 on 2024-10-23 10:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('research', '0007_alter_article_sponsor_color_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='article',
+            name='sponsor_color',
+            field=models.CharField(default='bg-red-700 !important', max_length=7),
+        ),
+        migrations.AlterField(
+            model_name='article',
+            name='sponsor_text_color',
+            field=models.CharField(default='#bg-gray-700 !important', max_length=7),
+        ),
+    ]

server/apps/research/migrations/0009_alter_article_sponsor_text_color.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.0.8 on 2024-10-23 10:58
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('research', '0008_alter_article_sponsor_color_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='article',
+            name='sponsor_text_color',
+            field=models.CharField(default='text-gray-700 !important', max_length=7),
+        ),
+    ]

server/apps/research/migrations/0010_article_sponsor_padding_alter_article_sponsor_color_and_more.py

@@ -0,0 +1,28 @@
+# Generated by Django 5.0.8 on 2024-10-23 11:20
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('research', '0009_alter_article_sponsor_text_color'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='article',
+            name='sponsor_padding',
+            field=models.CharField(default='px-4 py-6', max_length=20),
+        ),
+        migrations.AlterField(
+            model_name='article',
+            name='sponsor_color',
+            field=models.CharField(default='#FF0420', max_length=7),
+        ),
+        migrations.AlterField(
+            model_name='article',
+            name='sponsor_text_color',
+            field=models.CharField(default='#000000', max_length=7),
+        ),
+    ]

server/apps/research/migrations/0011_remove_article_sponsor_padding.py

@@ -0,0 +1,17 @@
+# Generated by Django 5.0.8 on 2024-10-28 05:02
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('research', '0010_article_sponsor_padding_alter_article_sponsor_color_and_more'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='article',
+            name='sponsor_padding',
+        ),
+    ]

server/apps/research/models/article.py

@@ -7,6 +7,9 @@
 from django.utils import timezone
 from django.conf import settings
 from tinymce.models import HTMLField
+import json
+from bs4 import BeautifulSoup
+import uuid
 
 def get_default_thumb():
     return f"{settings.MEDIA_URL}images/2077-Collective.png"
@@ -30,7 +33,11 @@ class Article(BaseModel):
     views = models.PositiveBigIntegerField(default=0)
     status = models.CharField(max_length=10, choices=options, default='draft', db_index=True)    
     scheduled_publish_time = models.DateTimeField(null=True, blank=True, db_index=True)    
-    
+    table_of_contents = models.JSONField(default=list, blank=True)
+    is_sponsored = models.BooleanField(default=False)
+    sponsor_color = models.CharField(max_length=7, default="#FF0420")
+    sponsor_text_color = models.CharField(max_length=7, default="#000000")
+
     objects = models.Manager()
     post_objects = ArticleObjects()
 
@@ -48,12 +55,38 @@ def calculate_min_read(self):
     def __str__(self):
         return self.title
 
-    def save(self, *args, **kwargs):
-        """Override the save method to generate a unique slug."""
+    def build_table_of_contents(self):
+        """Build the table of contents from the article content."""
+        soup = BeautifulSoup(self.content, 'html.parser')
+        headers = soup.find_all(['h1', 'h2', 'h3'])
+        
+        toc = []
+        stack = [{'level': 0, 'children': toc}]
+
+        for header in headers:
+            level = int(header.name[1])
+            title = header.get_text()
+            header['id'] = slugify(title)
 
+            while level <= stack[-1]['level']:
+                stack.pop()
+
+            new_item = {'title': title, 'id': header['id'], 'children': []}
+            
+            stack[-1]['children'].append(new_item)
+            stack.append({'level': level, 'children': new_item['children']})
+
+        self.table_of_contents = toc
+        self.content = str(soup)
+
+    def save(self, *args, **kwargs):
+        """Override the save method to generate a unique slug and build table of contents."""
         if not self.slug or self.title_update():
-            self.slug = self.generate_unique_slug()               
-       
+            self.slug = self.generate_unique_slug()
+        
+        if self.content:
+            self.build_table_of_contents()
+        
         if self.scheduled_publish_time and self.status == 'draft' and timezone.now() >= self.scheduled_publish_time:
             self.status = 'ready'
 
@@ -76,4 +109,4 @@ def title_update(self):
             original = Article.objects.filter(pk=self.pk).only('title').first()
             if original:
                 return original.title != self.title
-        return False
+        return False

server/apps/research/serializers/article_serializer.py

@@ -5,13 +5,14 @@
 
 class ArticleListSerializer(serializers.ModelSerializer):
     categories = CategorySerializer(many=True)
+    authors = AuthorSerializer(many=True)
 
     class Meta:
         model = Article
-        include = ['categories']
+        include = ['categories' 'authors']
         exclude = [
-            'content', 'authors', 'scheduled_publish_time', 'acknowledgement', 
-            'status', 'views', 'created_at', 'updated_at'
+            'content', 'scheduled_publish_time', 'acknowledgement', 
+            'status', 'views', 'created_at', 'updated_at', 'table_of_contents'
         ]
 
 class ArticleSerializer(serializers.ModelSerializer):
@@ -21,13 +22,13 @@ class ArticleSerializer(serializers.ModelSerializer):
     views = serializers.ReadOnlyField()
     min_read = serializers.ReadOnlyField()
 
-
     class Meta:
         model = Article
         fields = [
-            'id', 'slug', 'title', 'authors', 'thumb', 
-            'categories', 'summary', 'acknowledgement', 'content', 'min_read',
-            'status', 'views', 'created_at', 'updated_at', 'scheduled_publish_time'
+            'id', 'slug', 'title', 'authors', 'thumb', 'categories', 'summary',
+            'acknowledgement', 'content', 'min_read', 'status', 'views',
+            'created_at', 'updated_at', 'scheduled_publish_time', 'table_of_contents',
+            'is_sponsored', 'sponsor_color', 'sponsor_text_color'
         ]
 
 class ArticleCreateUpdateSerializer(serializers.ModelSerializer):
@@ -37,7 +38,7 @@ class ArticleCreateUpdateSerializer(serializers.ModelSerializer):
 
     class Meta:
         model = Article
-        fields = ['title', 'slug', 'categories', 'thumb', 'content', 'summary', 'acknowledgement', 'status', 'authors', 'scheduled_publish_time']
+        fields = ['title', 'slug', 'categories', 'thumb', 'content', 'summary', 'acknowledgement', 'status', 'authors', 'scheduled_publish_time', 'is_sponsored', 'sponsor_color', 'sponsor_text_color']
 
     def create(self, validated_data: dict) -> Article:
         """Create a new article instance."""
@@ -78,4 +79,4 @@ def update(self, instance: Article, validated_data: dict) -> Article:
 
             return instance
         except Exception as e:          
-            raise serializers.ValidationError(f"Error updating article: {str(e)}")
+            raise serializers.ValidationError(f"Error updating article: {str(e)}")

server/media/images/Screenshot_from_2024-10-23_05-08-02.png

@@ -2,7 +2,9 @@ amqp==5.2.0
 anyio==4.4.0
 asgiref==3.8.1
 attrs==24.1.0
+beautifulsoup4==4.12.3
 billiard==4.2.0
+bs4==0.0.2
 celery==5.4.0
 certifi==2024.7.4
 cffi==1.17.0
@@ -21,6 +23,7 @@ django-cors-headers==4.4.0
 django-filter==24.2
 django-js-asset==2.2.0
 django-shortcuts==1.6
+django-sortedm2m==4.0.0
 django-timezone-field==7.0
 django-tinymce==4.1.0
 djangorestframework==3.15.2
@@ -49,6 +52,7 @@ requests==2.32.3
 rpds-py==0.19.1
 six==1.16.0
 sniffio==1.3.1
+soupsieve==2.6
 sqlparse==0.5.1
 text-unidecode==1.3
 tzdata==2024.1