G3W-ADMIN-FRONTEND

G3W-ADMIN fronted portal for G3W-SUITE.

Docker Install

Running in Docker

• Clone the g3w-suite-docker repository

• Follow the instructions specified in the repo for running the containers i.e docker-compose up -d

• Exec into the running g3w-suite container.

docker-compose exec g3w-suite bash

NB: The g3w-suite container already sets the working directory as /code

• Add the frontend app using git submodule.

git submodule add -f https://github.com/g3w-suite/g3w-admin-frontend.git  g3w-admin/frontend

• Modify the settings_docker.py in your local repository to Add frontend module to G3W_LOCAL_MORE_APPS config value. The path to setting file is local_settings.py:

NB: Since local_settings.py is host mounted as a volume the changes are read instantly.

G3WADMIN_LOCAL_MORE_APPS = [
    ...
    'frontend'
    ...
]

• Whilst inside the running container of g3w-suite container makemigrations, migrate and collect static

In order to run the management command you need to set the display. Run the following

cd g3w-admin
export DISPLAY=:99

then run the following

python3 manage.py makemigrations frontend
python3 manage.py migrate frontend
python3 manage.py collectstatic --noinput

• Modify the settings_docker.py in your local repository to activate frontend module. The path to setting file is local_settings.py:

...
FRONTEND = True
FRONTEND_APP = 'frontend'
...

• Logout of the running g3w-suite container.

• Navigate to the URL specified by the docker-compose: http://localhost:8080

Installation in virtual env or on host (Debian / Ubuntu etc)

Add like git submodule from main g3w-admin directory

git submodule add -f https://github.com/g3w-suite/g3w-admin-frontend.git  g3w-admin/frontend

Add 'frontend' module to G3W_LOCAL_MORE_APPS config value inside local_settings.py:

G3WADMIN_LOCAL_MORE_APPS = [
    ...
    'frontend'
    ...
]

Apply migrations:

To build 'notes' database:

python3 manage.py makemigrations frontend
python3 manage.py migrate frontend
python3 manage.py collectstatic --noinput

To activate 'frontend' module and to set the frontend app for G3W-SUITE set in to local_settings.py:

...
FRONTEND = True
FRONTEND_APP = 'frontend'
...

• Navigate to the URL of the g3wsuite instance i.e http://localhost:8080