Set up project with Django and install DRF

.flake8

@@ -0,0 +1,15 @@
+[flake8]
+extend-ignore = E203
+include = 
+    user/*.py,
+    group/*.py
+exclude =
+    .git,
+    __pycache__,
+    docs/source/conf.py,
+    old,
+    build,
+    dist,
+    user/migrations/*,
+    group/migrations/*
+max-complexity = 10

.github/workflows/run_test.yml

@@ -0,0 +1,54 @@
+name: Lint, Test, and Generate Coverage report
+
+on:
+  pull_request:
+    branches:
+      - develop
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: ["3.9"]
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+        ports:
+          - 5432:5432
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+      - name: Lint with pylint and flake8
+        run: |
+          pylint --ignore=migrations group
+          pylint --ignore=migrations user
+          flake8 group
+          flake8 user
+      - name: Test with pytest
+        env:
+          SECRET_KEY: ${{ secrets.SECRET_KEY }}
+          DB_NAME: ${{ secrets.DB_NAME }}
+          DB_USER: ${{ secrets.DB_USER }}
+          DB_PASSWORD: ${{ secrets.DB_PASSWORD }}
+          DB_HOST: ${{ secrets.DB_HOST }}
+          DB_PORT: ${{ secrets.DB_PORT }}
+        run: coverage run -m pytest -v -s
+      - name: Generate coverage report
+        run: coverage report -m

.gitignore

@@ -0,0 +1,3 @@
+__pycache__/
+.env
+env/

Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.9
+
+WORKDIR /postit
+
+COPY requirements.txt .
+
+RUN pip install -r requirements.txt
+
+EXPOSE 8000
+
+CMD ["python", "manage.py", "runserver", "0.0.0.0:8000"]

Pipfile

@@ -0,0 +1,12 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+django = "*"
+
+[dev-packages]
+
+[requires]
+python_version = "3.7"

README.md

@@ -1 +1,55 @@
 # post-it-backend
+
+PostIt ​is a simple application that allows friends and colleagues to create groups for notifications. This way one person can post notifications to everyone by sending a message once. The application allows people to create accounts, create groups add registered users to the groups, and then send messages to these groups whenever they want.
+
+# Project Setup
+
+1. After cloning the repo, set up a virtual environment
+   `python3 -m venv .venv`
+
+2. Activate the virtual environment
+   `. .venv/bin/activate`
+
+3. Install the dependencies in requirements.txt
+   `pip install -r requirements.txt`
+
+4. Configure PostgresSQL
+   i) Open the PostgresSQL command line interface
+   `psql postgres`
+
+   ii) From your terminal, create a database
+   `CREATE DATABASE postit;`
+
+   iii) Create a user, feel free to replace the username and password
+   `CREATE USER admin WITH PASSWORD 'password';`
+
+   iv) Modify the connection parameters for the created user
+   `ALTER ROLE admin SET client_encoding TO 'utf8';`
+   `ALTER ROLE admin SET default_transaction_isolation TO 'read committed';`
+   `ALTER ROLE admin SET timezone TO 'UTC';`
+
+   v) Grant the user access rights to the database
+   `GRANT ALL PRIVILEGES ON DATABASE postit TO admin;`
+
+   vi) Exit the postgres command line
+   `\q`
+
+5. Create a .env file at the root of the project and set the database configurations there
+   `SECRET_KEY=your_secret_key`
+   `DB_NAME=postit`
+   `DB_USER=admin`
+   `DB_PASSWORD=your_password`
+   `DB_HOST=localhost`
+   `DB_PORT=5432`
+
+6. Make migrations
+   `python manage.py makemigrations`
+
+7. Migrate to create tables
+   `python manage.py migrate`
+
+8. Create a superuser
+   `python manage.py createsuperuser`
+
+9. Start the server
+   `python manage.py runserver`

api/admin.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

api/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class ApiConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'api'

api/models.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

api/tests.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

api/urls.py

@@ -0,0 +1,6 @@
+from django.urls import path, include
+
+urlpatterns = [
+    path('users/', include('user.urls')),
+    path('groups/', include('group.urls')),
+]

api/views.py

@@ -0,0 +1,3 @@
+from django.shortcuts import render
+
+# Create your views here.

docker-compose.dev.yml

@@ -0,0 +1,26 @@
+services:
+  db:
+    image: postgres
+    environment:
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
+    env_file:
+      - .env
+  web:
+    build: .
+    command: python manage.py runserver 0.0.0.0:8000
+    volumes:
+      - .:/postit
+    ports:
+      - "8000:8000"
+    depends_on:
+      - db
+    environment:
+      - SECRET_KEY=${SECRET_KEY}
+      - DB_NAME=${DB_NAME}
+      - DB_USER=${DB_USER}
+      - DB_PASSWORD=${DB_PASSWORD}
+      - DB_HOST=${DB_HOST}
+      - DB_PORT=${DB_PORT}
+    env_file:
+      - .env
+    tty: true

docker-compose.yml

@@ -0,0 +1,22 @@
+services:
+  db:
+    image: postgres
+    environment:
+      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
+  web:
+    build: .
+    command: python manage.py runserver 0.0.0.0:8000
+    volumes:
+      - .:/postit
+    ports:
+      - "8000:8000"
+    depends_on:
+      - db
+    environment:
+      - SECRET_KEY=${SECRET_KEY}
+      - DB_NAME=${DB_NAME}
+      - DB_USER=${DB_USER}
+      - DB_PASSWORD=${DB_PASSWORD}
+      - DB_HOST=${DB_HOST}
+      - DB_PORT=${DB_PORT}
+    tty: true

group/admin.py

@@ -0,0 +1,6 @@
+"""Register the Group model to see it in Django admin"""
+from django.contrib import admin
+from .models import Group, Message
+
+admin.site.register(Group)
+admin.site.register(Message)

group/apps.py

@@ -0,0 +1,8 @@
+"""Apps module"""
+from django.apps import AppConfig
+
+
+class GroupConfig(AppConfig):
+    """App class configuration"""
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'group'

group/migrations/0001_initial.py

@@ -0,0 +1,26 @@
+# Generated by Django 4.2.6 on 2023-10-30 08:26
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Group',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(max_length=255, unique=True)),
+                ('creator', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='groups_created', to=settings.AUTH_USER_MODEL)),
+                ('members', models.ManyToManyField(related_name='groups_joined', to=settings.AUTH_USER_MODEL)),
+            ],
+        ),
+    ]

group/migrations/0002_message.py

@@ -0,0 +1,26 @@
+# Generated by Django 4.2.6 on 2023-11-02 09:41
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('group', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Message',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('post', models.TextField()),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('group', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='messages', to='group.group')),
+                ('user', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='messages_authored', to=settings.AUTH_USER_MODEL)),
+            ],
+        ),
+    ]

group/models.py

@@ -0,0 +1,27 @@
+"""Models module"""
+from django.db import models
+from django.contrib.auth.models import User
+
+
+class Group(models.Model):
+    """Group class model"""
+    name = models.CharField(max_length=255, unique=True)
+    members = models.ManyToManyField(User, related_name='groups_joined')
+    creator = models.ForeignKey(User, on_delete=models.CASCADE,
+                                related_name='groups_created')
+
+    def __str__(self) -> str:
+        return str(self.name)
+
+
+class Message(models.Model):
+    """A model to define the structure of messages"""
+    post = models.TextField()
+    group = models.ForeignKey(Group, on_delete=models.CASCADE,
+                              related_name='messages')
+    user = models.ForeignKey(User, on_delete=models.CASCADE,
+                             related_name='messages_authored')
+    created_at = models.DateTimeField(auto_now_add=True)
+
+    def __str__(self):
+        return f'{self.user.username}: {self.post}'