Merge branch 'develop' into feature/parse-interface

Author: jgonggrijp

.gitignore

@@ -36,3 +36,4 @@ venv.bak/
 # Node
 node_modules/
 frontend/src/environments/version.ts
+*~

CONTRIBUTING.md

@@ -4,7 +4,7 @@ This document contains basic documentation for developing LangPro Annotator.
 
 ## Before you start
 
-You need to install the following software:
+You need to install the following software, *unless* you will be using Docker:
 
  - PostgreSQL >= 10, client, server and C libraries
  - Python >= 3.8, <= 3.10
@@ -36,7 +36,28 @@ Each subproject is configurable from the outside. Integration is achieved using
 If you are reading this document, you'll likely be working with the integrated project as a whole rather than with one of the subprojects in isolation. In this case, this document should be your primary source of information on how to develop or deploy the project. However, we recommend that you also read the "How it works" section in the document of each subproject.
 
 
-### Quickstart
+### Quickstart with Docker
+
+```console
+docker compose up -d
+```
+
+This will run the frontend and backend applications and watch all source files for changes. To run the backend unittests:
+
+```console
+docker compose exec backend pytest
+```
+
+To run the frontend unittests:
+
+```console
+docker compose exec frontend yarn ng test --no-browsers
+```
+
+then open http://localhost:9876 in a browser of choice.
+
+
+### Quickstart without Docker
 
 First time after cloning this project:
 
@@ -50,7 +71,12 @@ Running the application in [development mode][8] (hit ctrl-C to stop):
 $ yarn start
 ```
 
-This will run the backend and frontend applications, as well as their unittests, and watch all source files for changes. You can visit the frontend on http://localhost:8000/, the browsable backend API on http://localhost:8000/api/ and the backend admin on http://localhost:8000/admin/. On every change, unittests rerun, frontend code rebuilds and open browser tabs refresh automatically (livereload).
+This will run the backend and frontend applications, as well as their unittests, and watch all source files for changes.
+
+
+### Accessing the application
+
+You can visit the frontend on http://localhost:8000/, the browsable backend API on http://localhost:8000/api/ and the backend admin on http://localhost:8000/admin/. On every change, unittests rerun, frontend code rebuilds and open browser tabs refresh automatically (livereload).
 
 [8]: #development-mode-vs-production-mode
 

backend/Dockerfile

@@ -0,0 +1,11 @@
+FROM python:3.11
+
+WORKDIR /usr/src/app/backend
+COPY requirements.txt .
+RUN pip install -U pip pip-tools && pip-sync
+
+COPY . .
+
+CMD python manage.py check && \
+    python manage.py migrate && \
+    python manage.py runserver --settings glue --pythonpath .. 0.0.0.0:8000

docker-compose.yml

@@ -0,0 +1,43 @@
+services:
+    postgres:
+        image: postgres:15
+        environment:
+            - POSTGRES_PASSWORD=postgres
+        healthcheck:
+            test: 'psql -c "\l" postgres postgres'
+        restart: always
+        volumes:
+            - postgres-data:/var/lib/postgresql/data
+            - ./backend/create_db.sql:/docker-entrypoint-initdb.d/langpro.sql
+        ports:
+            - 127.0.0.1:5433:5432
+    backend:
+        build:
+            context: ./backend
+        environment:
+            PGHOST: postgres
+            LANGPRO_FRONTEND: 'http://frontend:4200'
+        depends_on:
+            postgres:
+                condition: service_healthy
+        healthcheck:
+            test: 'curl -f localhost:8000/admin/'
+        volumes:
+            - ./:/usr/src/app
+        ports:
+            - 127.0.0.1:8000:8000
+    frontend:
+        build:
+            context: ./frontend
+        healthcheck:
+            test: 'curl -f localhost:4200'
+        volumes:
+            - ./:/usr/src/app
+            - frontend-node-modules:/usr/src/app/frontend/node_modules
+        ports:
+            - 127.0.0.1:4200:4200
+            - 127.0.0.1:9876:9876
+
+volumes:
+    postgres-data:
+    frontend-node-modules:

frontend/Dockerfile

@@ -0,0 +1,6 @@
+FROM node:20
+
+WORKDIR /usr/src/app/frontend
+COPY . .
+
+CMD yarn && yarn ng serve --host 0.0.0.0 --disable-host-check --proxy-config ../proxy.conf.docker.json

glue.py

@@ -4,6 +4,7 @@
     backend/langpro_annotator/settings.py instead.
 """
 
+import os
 import os.path as op
 
 here = op.dirname(op.abspath(__file__))
@@ -39,5 +40,4 @@
 STATICFILES_DIRS += [
     op.join(here, 'frontend', 'src')
 ]
-PROXY_FRONTEND = "http://localhost:4200"
-
+PROXY_FRONTEND = os.getenv('LANGPRO_FRONTEND') or "http://localhost:4200"

proxy.conf.docker.json

@@ -0,0 +1,18 @@
+{
+    "/api": {
+        "target": "http://backend:8000",
+        "secure": false
+    },
+    "/users": {
+        "target": "http://backend:8000",
+        "secure": false
+    },
+    "/admin": {
+        "target": "http://backend:8000",
+        "secure": false
+    },
+    "/static": {
+        "target": "http://backend:8000",
+        "secure": false
+    }
+}