.github/workflows/publish.yml

@@ -0,0 +1,58 @@
+name: Publish
+
+on: push
+
+env:
+    # Use docker.io for Docker Hub if empty
+    REGISTRY: ghcr.io
+    # github.repository as <account>/<repo>
+    IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        permissions:
+            contents: read
+            packages: write
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+
+            # Login against a Docker registry
+            # https://github.com/docker/login-action
+            - name: Log into registry ${{ env.REGISTRY }}
+              uses: docker/login-action@v3
+              with:
+                  registry: ${{ env.REGISTRY }}
+                  username: ${{ github.actor }}
+                  password: ${{ secrets.GITHUB_TOKEN }}
+
+            # Extract metadata (tags, labels) for Docker
+            # https://github.com/docker/metadata-action
+            - name: Extract Docker metadata
+              id: meta
+              uses: docker/metadata-action@v5
+              with:
+                  images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+            # Setup QEMU emulator to build multi-arch images
+            # https://github.com/docker/setup-qemu-action
+            - name: Set up QEMU
+              uses: docker/setup-qemu-action@v3
+
+            # Configure Buildx for Docker build
+            # https://github.com/docker/setup-buildx-action
+            - name: Set up Buildx
+              uses: docker/setup-buildx-action@v3
+
+            # Build and push Docker image with Buildx
+            # https://github.com/docker/build-push-action
+            - name: Build and push Docker image
+              uses: docker/build-push-action@v5
+              with:
+                  context: .
+                  push: true
+                  tags: ${{ steps.meta.outputs.tags }}
+                  labels: ${{ steps.meta.outputs.labels }}
+                  platforms: 'linux/amd64,linux/arm64'

.gitignore

@@ -0,0 +1,7 @@
+/static/
+/db.sqlite3
+/debug.log
+/debug.log.*
+
+__pycache__/
+.DS_Store

Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.12.5-alpine AS build
+RUN apk --update --no-cache add git
+COPY requirements.txt ./
+RUN pip install --no-cache-dir -r requirements.txt
+
+
+FROM python:3.12.5-alpine AS runtime
+WORKDIR /usr/src/app
+RUN apk --update --no-cache add openjdk8-jre-base
+COPY --from=build /usr/local/lib/python3.12/site-packages /usr/local/lib/python3.12/
+COPY . .
+EXPOSE 8000
+VOLUME ["/tmp_home", "/persistent_home"]
+ENV DJANGO_TMP_HOME="/tmp_home"
+ENV DJANGO_PERSISTENT_HOME="/persistent_home"
+CMD ["gunicorn", "--bind", "0.0.0.0:8000", "--workers", "5", "--timeout", "600", "--max-requests", "25", "--max-requests-jitter", "5", "xlsform_prj.wsgi:application"]

README.md

@@ -0,0 +1,30 @@
+# Overview
+XLSForm Online is a Django-based web application that uses pyxform to convert a XLSForm to an ODK XForm and shows the preview of the Form in Enketo Express.
+
+# Run locally
+
+## Install requirements
+* Python 3
+* Java 8
+
+```
+pip install --requirement requirements.txt
+export DJANGO_SECRET_KEY=<secret value>
+export DJANGO_TMP_HOME=<location for temporary Forms>
+export DJANGO_PERSISTENT_HOME=<location for permanent Forms>
+python3 manage.py runserver
+```
+
+# Run in Docker
+```
+docker build --tag xlsform-online .
+docker run --detach --publish 5001:80 xlsform-online
+export DJANGO_SECRET_KEY=<secret value>
+export DJANGO_TMP_HOME=<location for temporary Forms>
+export DJANGO_PERSISTENT_HOME=<location for permanent Forms>
+docker run -e DJANGO_SECRET_KEY=$DJANGO_SECRET_KEY -v $DJANGO_TMP_HOME:/tmp_home -v $DJANGO_PERSISTENT_HOME:/persistent_home -p 8000:8000 xlsform-online
+```
+
+# CORS
+
+If you want to call `api/xlsform` from another application, please set the `DJANGO_CORS_ALLOWED_ORIGIN` environemnt variable, you can provide comma separated list for allowed origins e.g. `https://staging.enketo.getodk.org, http://localhost:5173`.

requirements.txt

@@ -1,3 +1,3 @@
-Django==3.2.19
-pyxform==1.12.1
-gunicorn==20.1.0
+Django==4.2.17
+pyxform@git+https://github.com/xlsform/pyxform@master
+gunicorn==22.0.0

xlsform_app/templates/upload.html

@@ -48,7 +48,7 @@
 			{% if itemsets_url %}
 			<a href="{{ itemsets_url }}" class="btn btn-success">Download external choices CSV</a>
 			{% endif %}
-			<a href="https://enketo.getodk.org/preview?form={{ xml_url | urlencode }}" target="_blank" class="btn btn-success">Preview in browser</a>
+			<a href="https://staging.enketo.getodk.org/preview?form={{ xml_url | urlencode }}" target="_blank" class="btn btn-success">Preview in browser</a>
 		</div>
 		{% endif %}
 	{% endif %}

xlsform_app/urls.py

@@ -1,11 +1,11 @@
-from django.conf.urls import url
+from django.urls import re_path
 from django.contrib.staticfiles.urls import staticfiles_urlpatterns
 from . import views
 
 urlpatterns = [
-    url(r'^json_workbook/', views.json_workbook),
-    url(r'^$', views.index),
-    url(r'^downloads/(?P<path>.*)$', views.serve_file),
+    re_path(r'^$', views.index),
+    re_path(r'^downloads/(?P<path>.*)$', views.serve_file),
+    re_path(r'^api/xlsform$', views.api_xlsform),
 ]
 
 urlpatterns += staticfiles_urlpatterns()