Webviz

Development

How to get started

The easiest way to set up a development environment (frontend + backend) is to run:

docker-compose up

You can then access

• frontend application at http://localhost:8080
• backend at http://localhost:8080/api/
• backend API documentation at http://localhost:8080/api/docs

Before you start however you need to create a file .env at the root of the project with the following variable:

WEBVIZ_CLIENT_SECRET=...

Hot reload

Both frontend and backend are hot reloaded through docker compose when files in the following folders are changed:

./frontend/public
./frontend/src
./frontend/theme
./backend/src

If other files are changed through the host operating system, e.g. typically when a new dependency is added, the relevant component needs to be rebuilt. I.e. docker-compose up --build frontend or docker-compose up --build backend.

Auto-generate /frontend/src/api

All the content in /frontend/src/api is auto-generated using the defined endpoints in the Python backend. In order to update the auto-generated code you can either

1. Run npm run generate-api --prefix ./frontend.
2. Use the VSCode tasks shortcut: a) Ctrl + P to open the command palette. b) Type > Tasks and enter to filter to commands only. c) Run task "Generate frontend code from OpenAPI".

In both cases the backend needs to already be running (e.g. using docker-compose as stated above).

Radix applications

We have two applications in Radix built from this repository:

• Main application built from the main branch.
• Review application built from the review branch.
• Dev application built from the dev branch.

The applications are automatically built and redeployed when pushing commits to the respective branch.

You can push/update the review branch with state of another feature branch with e.g.:

git push upstream <featurebranchname>:review --force

The main branch only accepts commits through pull requests.

NB: Note that Radix will always use the radixconfig.yml as it is in main branch (unless changed in Radix UI).

Usage in GitHub codespaces

Using the standard GitHub codespace image, you can easily start up the application by running the same command as locally:

docker-compose up

in the terminal. When using GitHub codespaces you do not have to create the .env file since environment variables are automatically set up for you at startup through repository settings. Note that you need to have at least "collaborator" role in the repository in order to have environment variables automatically set up.

When you start up the docker containers, GitHub codespace will automatically make a link where you can access the application in development mode (i.e. changes you do the code will automatically be reflected in the application).