https://github.com/devs-group/wagtail-nuxt

https://github.com/devs-group/wagtail-nuxt

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/devs-group/wagtail-nuxt
• Owner: devs-group
• Created: 2020-05-13T10:33:05.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-02-10T22:25:39.000Z (almost 3 years ago)
• Last Synced: 2023-03-08T11:12:49.279Z (almost 2 years ago)
• Language: Python
• Size: 907 KB
• Stars: 15
• Watchers: 3
• Forks: 5
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

# Table of Contents

1.  [Requirements](#org98at330)

2.  [Local Setup](#org57856e7)

    1.  [Endpoints](#org809e937)

        1.  [Frontend - Nuxt](#orgc37a804)

        2.  [Backend - Admin](#org211c10f)

        3.  [GraphQL - GraphiQL](#orgc70d5b5)

        4.  [Static Files - MinIO](#org8110bc6)

    2.  [Credentials](#org749259c)

        1.  [DB - Postgre](#orgc6c10a9)

        2.  [Backend - Admin](#orge1ac287)

        3.  [Static Files - MinIO](#orgc1fcbcb)

3.  [Branding](#org13fa485)        

4.  [Frontend](#orgc473881)

5.  [Administration](#orgbf9c4d0)

    1.  [Delete all Wagtail Images](#orgf36cc02)

    2.  [Migrate Changes](#org2525778)

    3.  [Persist Data](#org0ac7a34)



# Requirements

You need to have [docker](https://docs.docker.com/get-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](.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](#org749259c).



### Frontend - Nuxt



### Backend - Admin



### GraphQL - GraphiQL



### Static Files - MinIO



## 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](web_frontend/README.md)



# Administration

To interface with the containers, a Makefile is provided which provides additional

management commands to the [default django-admin commands](https://docs.djangoproject.com/en/3.0/ref/django-admin/).



## 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