KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agents #developer-tools #ai-agent #claude-code #mcp #typescript #codex #cli #rust #deepseek-harness

mashroom

★ 60 Open GitHub ↗

Mashroom Server, an Integration Platform for Microfrontends

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![Mashroom Server](https://raw.githubusercontent.com/nonblocking/mashroom/master/logos/logo-primary-shades-with-text.svg)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![GitHub CI](https://github.com/nonblocking/mashroom/actions/workflows/mashroom_ci_build.yml/badge.svg)](https://github.com/nonblocking/mashroom/actions/workflows/mashroom_ci_build.yml)

> [!WARNING]
> This branch contains the upcoming 3.0 release which is not production ready yet.
> The current stable branch is [2.x](https://github.com/nonblocking/mashroom/tree/v2_maintainance).

# About

*Mashroom Server* is a *Node.js* based **Microfrontend Integration Platform**. It supports the integration of *Express* web-apps on the
server side and composing pages from multiple *Single Page Applications* (*Portal Apps*) on the client side.
It also provides common infrastructure such as role-based security, communication (publish/subscribe), theming, i18n, storage,
and logging out of the box and supports custom middleware and services via plugins.

It allows it to implement SPAs completely independently and without a vendor lock-in, and to use it on arbitrary pages
with different configurations and even multiple times on the same page. Registered SPAs (*Portal Apps*) can also be loaded and unloaded dynamically,
hence they can be used as building blocks for *Composite Apps* or as part of a *dynamic Cockpit*.

The *Mashroom Portal* plugin, which is responsible for rendering *Portal Apps* is fully capable of *Hybrid Rendering*.
It renders the initial page requested by the user completely on the server-side (if all *Portal Apps* on the page also support SSR)
and dynamically exchanges the content on the client-side for subsequent pages.

From a technical point of view, the core of *Mashroom Server* is a plugin loader that scans npm packages for
plugin definitions (package.json, mashroom.json) and loads them at runtime.
Such a plugin could be an *Express* web-app or an *SPA* or more generally all kinds of code it knows how to load,
which is determined by the available plugin loaders.
Plugin loaders itself are also just plugins, so it is possible to add any type of custom plugin type.

## Key features

### Portal

* Registration of Single Page Applications Microfrontends (**Portal Apps**) written with any frontend framework
    (basically, you just need to implement a startup function and provide some metadata)
  * Registration of *Portal Apps* on remote servers or in Kubernetes clusters
  * Registration of any [OpenMicrofrontends](https://open-microfrontends.org) compliant Microforntend as *Portal App*
  * Support for *Portal Apps* shipped as *IIFE*, *ES modules* or *SystemJS modules*
  * Support for sharing vendor libraries between *Portal Apps* (global libraries or Import Maps)
  * Creation of static pages with registered *Portal Apps* as building blocks
  * Support for **dynamic cockpits** where Portal Apps are loaded (and unloaded) based on some user interaction or search results
  * Support for **Composite Apps** which can use any registered *Portal App* as building blocks
    (which again can serve as building blocks for other composite Apps)
  * Each *Portal App* receives a config object which can be different per instance and a number of JavaScript services
    (e.g., to connect to the message bus or to load other Apps)
  * Support for **Hybrid Rendering** for both the Portal pages and *Portal Apps*
    (if it supports server-side rendering, the initial HTML can be incorporated
    into the initial HTML page. Navigating to another page dynamically replaces the *Portal Apps* in the content area)
  * Editing the *Portal App* config via *Admin Toolbar* or a custom Editor App which again is just a *Portal App*
  * Client-side message bus for inter-app communication, which can be extended to server-side messaging
    (to communicate with Apps in other browsers or even in third party systems)
  * Arbitrary (custom) layouts for pages
  * Extensive **theming** support
    (Themes can be written in any Express template language)
  * Support for multiple sites that can be mapped to virtual hosts
  * Proxying of REST API calls to avoid CORS problems (HTTP, SSE, WebSocket)
  * Delivering of Theme and Portal App resources via CDN
  * Admin Toolbar to create pages and place Apps via Drag'n'Drop
  * **Hot reload** of (local) *Portal Apps* in development mode
  * MCP server that allows coding agents to register and place *Portal Apps* on pages

### Core

* Shared middlewares and services
  * **Service abstractions** for security, internationalization, messaging, HTTP proxying, memory cache, and storage
  * Existing provider plugins for security (OpenID Connect, LDAP), storage (File, MongoDB), messaging (MQTT, AMQP) and caching (Redis)
  * Integration of (existing) _Express_ web-apps
  * Integration of (existing) _Express_ (REST) APIs
  * Role- and IP-based **access control** for URLs
  * Definition of access restrictions for arbitrary resources (such as Sites, Pages, App instances)
  * Single configuration file to override plugin defaults
  * Support for "remote" plugins
  * Support for **custom plugin types**
  * Extensive **monitoring** and export in Prometheus format
  * Hot deploy, undeploy, and reload of all kinds of plugins
  * Native TypeScript support (all config files and plugins can be written in TypeScript)
  * No compile-time or runtime dependencies to the server
  * Fast and lightweight

# Quick Start

**Coming soon**

For v2 Quick Start see https://github.com/nonblocking/mashroom/tree/v2_maintainance#quick-start.

# Screenshots

## A Portal page with multiple *Portal Apps* (Microfrontends)

![Mashroom Portal](https://raw.githubusercontent.com/nonblocking/mashroom/master/screenshots/mashroom-portal.png)

![Mashroom Portal Dark Mode](https://raw.githubusercontent.com/nonblocking/mashroom/master/screenshots/mashroom-portal-dark.png)

## Add an App to a Portal Page

![Mashroom Portal Add App](https://raw.githubusercontent.com/nonblocking/mashroom/master/screenshots/mashroom-portal-add-app.gif)

## Bootstrap-based (default) Theme with a Microfrontend using Bootstrap components

![Mashroom Portal Bootstrap Theme](https://raw.githubusercontent.com/nonblocking/mashroom/master/screenshots/mashroom-portal-bootstrap-theme.png)

## Tailwind-based Theme with a Microfrontend using Shadcn components

![Mashroom Portal Tailwind Theme](https://raw.githubusercontent.com/nonblocking/mashroom/master/screenshots/mashroom-portal-tailwind-theme.png)

## Registering and adding Apps via Code Agent

![Mashroom MCP](https://raw.githubusercontent.com/nonblocking/mashroom/master/screenshots/mashroom-portal-mcp.png)

## Admin UI

![Admin UI](https://raw.githubusercontent.com/nonblocking/mashroom/master/screenshots/mashroom-admin-ui.png)

## Kubernetes Integration

![Kubernetes Integration](https://raw.githubusercontent.com/nonblocking/mashroom/master/screenshots/mashroom-admin-ui-k8s.png)

# Homepage

[https://www.mashroom-server.com](https://www.mashroom-server.com)

# Full Documentation

**Coming soon**

For Mashroom v2 documentation see https://www.mashroom-server.com/documentation/.

# Blog

[https://medium.com/mashroom-server](https://medium.com/mashroom-server)

# Youtube Channel

[https://www.youtube.com/@mashroomserver](https://www.youtube.com/@mashroomserver)

# Development Resources

## Templates

**Coming soon**

## Plugin Examples

[https://github.com/nonblocking/mashroom-plugin-demos](https://github.com/nonblocking/mashroom-plugin-demos)

## Remote Portal App Demos

* [https://github.com/nonblocking/mashroom-demo-remote-portal-app](https://github.com/nonblocking/mashroom-demo-remote-portal-app)
 * [https://github.com/nonblocking/mashroom-demo-ssr-remote-portal-app](https://github.com/nonblocking/mashroom-demo-ssr-remote-portal-app) (supports server-side rendering)

## Dynamic Cockpit Demo

[https://github.com/nonblocking/mashroom-demo-dynamic-cockpit](https://github.com/nonblocking/mashroom-demo-dynamic-cockpit)

## Microfrontend Platform based on Mashroom and Kubernetes Demo

[https://github.com/nonblocking/microfrontend-platform-kubernetes](https://github.com/nonblocking/microfrontend-platform-kubernetes)

mashroom

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README