MAT2 Quasar Frontend (PWA)

This is a frontend for MAT2-web.

How To Deploy

Manual Deployment with custom build

1. Install dependencies: yarn install
2. Export env variable MAT2_API_URL_PROD which points to your MAT2-web backend e.g. MAT2_API_URL_PROD=https://mybackend.gnu/. Alternatively you can define the URL in the quasar.conf.js file on the following line: API_URL: JSON.stringify(process.env.MAT2_API_URL_PROD) and change it to: API_URL: 'https://mybackend.gnu/'
3. quasar build -m pwa (Must have installed the quasar cli)
4. Copy the files from ./dist/pwa to your hosting.
5. Enjoy :)

Deployment with Docker

Registry Frontend: https://0xacab.org/jfriedli/mat2-quasar-frontend/container_registry

Registry Backend: https://0xacab.org/jvoisin/mat2-web/container_registry

On every new tag/master a new Docker Container is built. To configure its API Url you have to pass the environment variable MAT_API_HOST_PLACEHOLDER which points to your backend. Make sure it has a slash at the end ;). Internally this replaces a placeholder string in the prebuilt JS/HTML/CSSS files and starts an NGINX server.

Example: Build the container: docker build --build-arg MAT2_API_URL_PROD='$MAT_API_HOST_PLACEHOLDER' -t mat2frontend . Or alternatively get it from the registry prebuilt.

Then run it: docker run -it -e MAT_API_HOST_PLACEHOLDER='https://mybackend.gnu/' -p 80:80 mat2frontend

Contribute

Up and Running for development

To start developing clone this repository and run docker-compose up. If this was successful you can access the app on: localhost:8080. This will start the backend as well using it's latest docker image. Codechanges will trigger an instant update in your browser. If you update/add/remove dependencies you'll have to rebuild the container: docker-compose up --build.

If you don't want to use docker-compose.

1. yarn install
2. yarn global add @quasar/cli
3. quasar dev

Make sure you have a running backend instance that you can reference in the quasar.js file.

Branching Workflow

For solving an issue you'll start by creating a branch and merge request for it. When it's done you'll make a merge request for from your branch into the develop branch.

Branch	Description
Develop	The develop branch MIGHT contain non *operational code
Master	The Master branch MUST contain *operational code

*operational: This means the code itself contains only working features and finished tasks that have been tested and are known to be working.

Tags

We do use tags to mark releases. A tag SHOULD reference the master branch. On tag creation you have to submit a changelog.

Configuration

To set the base url of the backend you have to define MAT2_API_URL_DEV for dev builds and MAT2_API_URL_PROD for production builds. If you use the docker environment this is customizable in the docker-compose.yml file. If none of these are set it will default to http://localhost:5000/ (slash at the end).

Translations

We'd love to receive any translation merge requests :).

Dependency Management

We do use renovate which checks every night for updates and creates automated merge request.

E2E Tests

Run the E2E tests: quasar test --e2e cypress. We use the cypress.io framework for testing. The E2E tests are run during the ci phase.

Docker

To build the prodcution image: docker build -t mat-web-frontend . The nginx runs as non privileged user.

To start the container: docker run -ti -p8080:8080 --security-opt no-new-privileges --security-opt seccomp=seccomp.json --read-only --tmpfs /var/www/html --tmpfs /tmp mat-web-frontend:latest This starts it on your host machine on port 8080.

Podman

Build: podman build -t matweb-frontend .

Run: podman run -ti --security-opt=no-new-privileges --read-only -p8080:8080 --tmpfs /var/www/html --tmpfs /tmp --security-opt no-new-privileges --security-opt seccomp=seccomp.json matweb-frontend

Design

You can find the design documents here: https://0xacab.org/jfriedli/mat2-quasar-frontend/-/wikis/Design-Documents