Table of Contents

1. Requirements
2. Local Setup
   1. Endpoints
      1. Frontend - Nuxt
      2. Backend - Admin
      3. GraphQL - GraphiQL
      4. Static Files - MinIO
   2. Credentials
      1. DB - Postgre
      2. Backend - Admin
      3. Static Files - MinIO
3. Branding
4. Frontend
5. Administration
   1. Delete all Wagtail Images
   2. Migrate Changes
   3. Persist Data

Requirements

You need to have docker and preferely docker-compose installed on your system.

Local Setup

Follow these steps to set everything up locally on your machine

1. Clone repo

   git clone https://gitlab.com/devs-group/base-wagtail.git && cd base-wagtail
   

2. Copy .env.dist to .env

   cp .env.dist .env
   

3. Install node modules

   cd web_frontend
   yarn install
   

4. Start Containers with docker-compose

   docker-compose up -d
   

Endpoints

As soon as everything is up and running visit these addresses to interact with the provided APIs, where necessary use Credentials.

Frontend - Nuxt

http:localhost:3000

Backend - Admin

http:localhost:8000/admin

GraphQL - GraphiQL

http:localhost:8000/api/graphiql

Static Files - MinIO

http:localhost:9000

Credentials

Default Credentials for the dev setup containing only insensitive test data. It is advised to change these in the .env.dist and .env files.

DB - Postgre

database	cms
user	root
password	root

Backend - Admin

user	root
password	root

Static Files - MinIO

access-key	root
secret-key	rootroot

Branding

Search the project for strings starting with "PLACEHOLDER_" and exchange to enable custom branding of the admin panel and more.

Frontend

Details concerning the nuxt instance serving the frontend can be found in its own README

Administration

To interface with the containers, a Makefile is provided which provides additional management commands to the default django-admin commands.

Delete all Wagtail Images

If there is a key not found error due to a dead reference, wagtail images might be the problem. It usually helps to delete all instances of the wagtail.images.Image class. This make command shortens the procedure:

make deletewagtailimages

Migrate Changes

To shorten the migration process after a database relevant change was made use:

make migrate

This will execute inside the container the commands ./manage.py makemigrations and ./manage.py migrate

Persist Data

To be able to work with data from a different docker volume, fixtures can be created with:

make backup

To load the fixtures us:

make load