acdh-oeaw/4dpuzzle

A web app to publish data from the Tell el Daba

A Puzzle in 4D - Tell el-Daba

djangobaserprojct based app for A Puzzle in 4D

install

• clone the repo
• change into the project's root directory e.g. cd p4d
• create a virtual environment e.g. virutalenv env and activate it source env/bin/activate
• install required packages pip install -r requirements_dev.txt
• run migrations python manage.py migrate
• start the dev sever python manage.py runserver
• go to http://127.0.0.1:8000 and check if everything works

Docker

At the ACDH-CH we use a centralized database-server. So instead of spawning a database for each service our services are talking to a database on this centralized db-server. This setup is reflected in the dockerized setting as well, meaning it expects an already existing database (either on your host, e.g. accessible via 'localhost' or some remote one)

building the image

• docker build -t p4d:latest .
• docker build -t p4d:latest --no-cache .

running the image

To run the image you should provide an .env file to pass in needed environment variables; see example below:

• docker run -it -p 8020:8020 --rm --env-file docker.env --name p4d p4d:latest

4dpuzzle's Issues

set up test workflow

dockerize application

linting

lint all code and set up linting gh-action

what to do with shared-assets depenency

a lot of static assets like images, videos are fetched from https://shared.acdh.oeaw.ac.at/4dpuzzle/
but also some 3rd party libraries (those should be included into the codebase)

change address in footer

upgrade python packages to latest version

set up deployment workflow

use new imprint service

tests for CRUD views of `archiv` app