@dd-decaf/metabolica

Metabolica UI

Metabolica is a software-suite for cell factory engineering.

This package contains the essentials for the UI of Metabolica:

• A pluggable UI wireframe upon which components can be written
• A few standard components: login, app.docs, app.project
• A few modules for component interaction: app, xrefs, sharing, search
• Some shared legacy code that will be moved into individual modules later on.

Installation

At the moment, metabolica is still a private package. To install it, check out this repository or use NPM:

npm install github:biosustain/metabolica-ui --save

Development

Ensure you have a recent version of Node.js installed on your system.

First, check out the repository. In the root directory, run:

npm install

Run the development server:

npm start

In its default configuration, the development server expects a compatible API to run on http://localhost/ (port 80). Please consult the API server documentation about how to do this. To change the target URL of the API, set the METABOLICA_DEV_API_HOST environment variable.

Development should follow DTU Biosustain guidelines with semantic commit messages.

Naming

New Metabolica UI components should follow the metabolica-{componentModuleName} naming scheme for their NPM packages. Their GitHub repositories should follow the metabolica-ui-{componentModuleName} naming scheme.

Any server-side code may use GitHub repositories using the metabolica-{componentModuleName} naming scheme.

Documentation

• AngularJS

• Angular Material

• webpack

  This project uses webpack 3 for the development server, compilation and bundling.