release version 1

.github/workflows/ci-linter-backend.yaml

@@ -0,0 +1,22 @@
+name: UGent-3-backend-linter
+run-name: ${{ github.actor }} is running backend linter 🚀
+on:
+  pull_request:
+    paths:
+      - 'backend/**'
+jobs:
+  Backend-tests:
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+          cache: 'pip'
+
+      - name: Run linting
+        working-directory: ./backend
+        run: find . -type f -name "*.py" | xargs pylint 
+

.github/workflows/ci-linter-frontend.yaml

@@ -0,0 +1,30 @@
+name: UGent-3-frontend-linter
+run-name: ${{ github.actor }} is running frontend linter 🚀
+on:
+  pull_request:
+    paths:
+      - 'frontend/**'
+jobs:
+  Frontend-tests:
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: npm-${{ hashFiles('package-lock.json') }}
+          restore-keys: npm-
+
+      - name: Install dependencies
+        working-directory: ./frontend
+        run: npm i eslint
+
+      - name: Run linting
+        working-directory: ./frontend
+        run: npm run lint
+

.github/workflows/ci-test-backend.yaml

@@ -0,0 +1,27 @@
+name: UGent-3-backend-test
+run-name: ${{ github.actor }} is running backend tests 🚀
+on:
+  pull_request:
+    paths:
+      - 'backend/**'
+jobs:
+  Backend-tests:
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+          cache: 'pip'
+
+      - name: Install dependencies
+        working-directory: ./backend
+        run: pip3 install -r requirements.txt && pip3 install -r dev-requirements.txt
+
+      - name: Running tests
+        working-directory: ./backend
+        run: bash ./run_tests.sh
+
+

.github/workflows/ci-test-frontend.yaml

@@ -0,0 +1,38 @@
+name: UGent-3-frontend-test
+run-name: ${{ github.actor }} is running frontend tests 🚀
+on:
+  pull_request:
+    paths:
+      - 'frontend/**'
+jobs:
+  Frontend-tests:
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+
+      - name: Cache dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.npm
+          key: npm-${{ hashFiles('package-lock.json') }}
+          restore-keys: npm-
+
+      - name: Install dependencies
+        working-directory: ./frontend
+        run: npm ci
+
+      - name: Build
+        working-directory: ./frontend
+        run: npm run build
+
+      - name: Preview Web App
+        working-directory: ./frontend
+        run: npm run preview &
+
+      - name: Running tests
+        working-directory: ./frontend
+        run: npm test
+

README.md

@@ -1 +1,21 @@
-# UGent-3
+# UGent-3 project peristerónas
+![tests](https://github.com/SELab-2/UGent-3/actions/workflows/ci-test-frontend.yaml/badge.svg)
+![linter](https://github.com/SELab-2/UGent-3/actions/workflows/ci-linter-frontend.yaml/badge.svg)
+![tests](https://github.com/SELab-2/UGent-3/actions/workflows/ci-test-backend.yaml/badge.svg)
+![linter](https://github.com/SELab-2/UGent-3/actions/workflows/ci-linter-backend.yaml/badge.svg)
+## Introduction
+Project peristerónas was created to aid both teachers and students in achieving a
+clear overview of deadlines and projects that need to be submitted.
+
+There's a separate functionality depending on if you're logged in as a teacher or as a student.
+For students the main functionality is to have a user-friendly interface to submit projects and check the correctness of their submissions.
+
+When a teacher is logged in they can get an overview of the projects he assigned and check how many students have already
+handed in a correct solution for example. It's also possible to edit the project and to grade projects in peristerónas' interface. 
+## Usage
+### Frontend
+For the developer instructions of the frontend please refer to the [frontend readme](frontend/README.md)
+where clear instructions can be found for usage, test cases, deployment and development.
+### Backend
+For the developer instructions of the backend please refer to the [backend readme](backend/README.md)
+where clear instructions can be found for usage, test cases, deployment and development.

backend/.gitignore

@@ -7,4 +7,6 @@ __pycache__/
 htmlcov/
 docs/_build/
 dist/
-venv/
+venv/
+.env
+.run/

backend/Dockerfile

@@ -1,6 +1,20 @@
+FROM docker:dind as builder
+
 FROM python:3.9
+
+COPY --from=builder /usr/local/bin/docker /usr/local/bin/docker
+
 RUN mkdir /app
-WORKDIR /app/
+WORKDIR /app
+
 ADD ./project /app/
+
+COPY requirements.txt /app/requirements.txt
+
 RUN pip3 install -r requirements.txt
-CMD ["python3", "/app"]
+
+COPY . /app
+
+ENTRYPOINT ["python"]
+
+CMD ["__main__.py"]

backend/Dockerfile.test

@@ -0,0 +1,24 @@
+FROM docker:dind
+
+RUN apk add --no-cache \
+    python3 \
+    py3-pip \
+    tzdata
+
+ENV TZ=UTC
+RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
+
+
+
+RUN python3 -m venv /venv
+ENV PATH="/venv/bin:$PATH"
+
+COPY . /app
+
+WORKDIR /app
+
+RUN pip3 install --no-cache-dir -r requirements.txt -r dev-requirements.txt
+
+RUN chmod +x /app/entry-point.sh
+
+ENTRYPOINT ["/app/entry-point.sh"]

backend/Dockerfile_auth_test

@@ -0,0 +1,9 @@
+FROM python:3.9
+RUN mkdir /auth-app
+WORKDIR /auth-app
+ADD ./test_auth_server /auth-app/
+COPY auth_server_requirements.txt /auth-app/requirements.txt
+RUN pip3 install -r requirements.txt
+COPY . /auth-app
+ENTRYPOINT ["python"]
+CMD ["__main__.py"]

backend/README.md

@@ -0,0 +1,79 @@
+# Project pigeonhole backend
+![tests](https://github.com/SELab-2/UGent-3/actions/workflows/ci-test-backend.yaml/badge.svg)
+![linter](https://github.com/SELab-2/UGent-3/actions/workflows/ci-linter-backend.yaml/badge.svg)
+## Prerequisites
+**1. Clone the repo**
+   ```sh
+   git clone git@github.com:SELab-2/UGent-3.git
+   ```
+**2. Installing required packages**
+
+   If you want the development environment: run both commands. If you only need to deploy, run the deployment command.
+
+   The [dev-requirements.txt](dev-requirements.txt) contains everything for writing tests and linters for maintaining quality code.
+On the other hand the regular [requirements.txt](requirements.txt) installs the packages needed for 
+the regular base application.
+
+   - Deployment
+   ```sh
+   pip install -r requirements.txt
+   ```
+   - Development
+   ```sh
+   pip install -r dev-requirements.txt
+   ```
+
+## Setting up the environment variables
+The project requires a couple of environment variables to run, if you want to develop on this codebase.
+Setting values for these variables can be done with a method to your own liking.
+
+| Variable                               | Description                                                                                                                                                                                                                                                                                                                       |
+|----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| POSTGRES_USER                          | Name of the user, needed to login to the postgres database                                                                                                                                                                                                                                                                        |
+| POSTGRES_PASSWORD                      | Password of the user, needed to login to the postgres database                                                                                                                                                                                                                                                                    |
+| POSTGRES_HOST                          | Location of the postgres database                                                                                                                                                                                                                                                                                                 |
+| POSTGRES_DB                            | Name of the postgres database                                                                                                                                                                                                                                                                                                     |
+| API_HOST                               | Location of the API root                                                                                                                                                                                                                                                                                                          |
+| CLIENT_ID                              | [Client id](https://learn.microsoft.com/nl-nl/entra/identity-platform/v2-protocols)                                                                                                                                                                                                                                               |
+| CLIENT_SECRET                          | Client's secret is your personal secret key for authentication, this can be found at the [Entra ID admin center](https://learn.microsoft.com/en-us/purview/sit-defn-azure-ad-client-secret)                                                                                                                                                                                                                |
+| JWT_SECRET_KEY                         | JWT secret key is the key used to encode the JWT's and should be kept secret, because otherwise everyone can create "valid" JWT's for our application. Variable should be a random 32 characters long string, if you need more information please refer to the [RDF documentation](https://www.rfc-editor.org/rfc/rfc4868#page-3) |                       
+| TENANT_ID                              | [Tenant id](https://learn.microsoft.com/nl-nl/entra/fundamentals/whatis), an ID that is used to identify yourself to the microsoft servic                                                                                                                                                                                         |                     
+| HOMEPAGE_URL                           | URL of where the website's homepage is located                                                                                                                                                                                                                                                                                    |
+
+All the variables except the last one are for the database setup,
+these are needed to make a connection with the database.
+The last one is for keeping the API restful since the location of the resource should be located.
+
+## Running the project
+Once all the setup is done you can start the development server by
+navigating to the backend directory and running:
+```sh
+python project
+``` 
+The server should now be located at `localhost:5000` and you can
+start developing.
+
+## Maintaining the codebase
+### Writing tests
+When writing new code it is important to maintain the right functionality so 
+writing tests is mandatory for this, the test library used in this codebase is [pytest](https://docs.pytest.org/en/8.0.x/).
+
+If you want to write tests we highly advise to read the pytest documentation on how
+to write tests, so they are kept conventional.
+
+For executing the tests and testing your newly added functionality
+you can run:
+```sh
+sudo ./run_tests.sh
+``` 
+
+Located in the backend directory.
+### Running the linter
+This codebase is kept clean by the [pylint](https://pypi.org/project/pylint/) linter.
+
+If you want to execute the linter on all .py files in the project it can simply be done
+with the command:
+```sh
+find . -type f -name "*.py" | xargs pylint
+``` 
+The code needs to get a 10/10 score to get pushed to the repository.

backend/auth_server_requirements.txt

@@ -0,0 +1,4 @@
+flask~=3.0.2
+flask-restful
+python-dotenv~=1.0.1
+psycopg2-binary