Skip to content

Latest commit

 

History

History
32 lines (19 loc) · 1.53 KB

README.md

File metadata and controls

32 lines (19 loc) · 1.53 KB
Raw

Admin interface for andrew powered by Django

Docker Image: https://hub.docker.com/r/gesiscss/andrew-django-admin

Helm Chart Repository: https://gesis-methods-hub.github.io/andrew-django-admin (see index.yml)

andrew (Aggregator for Navigatable Discoverable Reproducible and Educational work) is a R package to help with the creation of a website that shows a collection of tutorials or vignette. This Django web app provides a user interface to manager the collection of tutorials or vignette and a REST API (powered by Django REST framework) to be consumed by andrew.

Features

  • Admin panel (/admin)
  • Web form to add content (/cms)
  • API endpoint to get enabled content (/cms/api/content)
  • API endpoint to get navigation tree of enabled content (/cms/api/collection)

Development

For development, we recomommend to use Docker Compose.

On your terminal, execute

docker compose up

and your development environment should be ready. This repository is bind mounted into the container, database migrations are executed, and the Django server is started. Read the log in the terminal for more details.

A collection of how-to is included in CONTRIBUTING.md.

Production

For production, we recommned to run the provided Helm Chart on Kubernetes.