MMUX Vite

This repository is under active development. It aims to bring up meta-modeling functionality in an interactive, user-friendly, guided step-by-step way.

It uses Vite (and React) for the front-end, and Python (via Flask) for the backend. Additionally, it connects to the OSPARC backend through its API (which is actively being expanded with "Functions" and related content to allow for meta-modeling functionality).

Coverage

CI uploads unit-test coverage to Codecov with separate node and flaskapi flags, plus Chromium browser coverage from the Playwright suite under the e2e flag.

Run Node coverage locally with:

cd node && npm ci && npm run test:coverage

Run the Playwright browser coverage locally with:

make test-e2e

Run backend coverage locally with:

make test-flaskapi

CI combines regular and analytical backend coverage before uploading it.

Development

To setup your development environment, you need to fill it with the API access data from your oSPARC's account. Login on a deployment with your account and create a New API Key and use that data to fill out the generated .env file:

make .env

Make sure your images have been build (since they are used as a base for mounting the loca source folders)

make build

Install and run the repository hooks before opening a PR:

uvx prek install
make prek

Start for development mode with

make run-develop

NOTE: code will be running inside docker containers.

Final validation step

When done editing always validate the production build of the app with the below command, since it's the only one giving some minor guarantee on the corectness of your changes.

make run-prod-local

Updating the ospsarc package

The backend relies on the osparc package to interact with the oSPARC's API server. If he API server specs change, you would most likley need to create a new release of this service. Instructions:

Fork https://github.com/ITISFoundation/osparc-simcore-clients and clone your fork locally

cd api
make openapi-osparc-simore-master-branch
git commit -am "updated specs form osparc-simcore master branch"

Push your changes and create a PR which needs to be merged.

After the PR is merged, the CI will automatically publish a new version of this client which can be found here https://pypi.org/project/osparc/0.8.3.post0.dev27/#history Get the latest version and repalce it in falskapi/Dockerfile. At the time of writing this it was osparc==0.8.3.post0.dev27.