mjancarik/merkur

tiny extensible javascript library for front-end microservices

Merkur

The Merkur is tiny extensible javascript library for front-end microservices(micro frontends). It allows by default server side rendering for loading performance boost. You can connect it with other frameworks or languages because merkur defines easy API. You can use one of six predefined template's library Preact, µhtml, Svelte and vanilla but you can easily extend for others.

Features

• Flexible templating engine
• Usable with all tech stacks
• SSR-ready by default
• Easy extensible with plugins
• Tiny - 1 KB minified + gzipped

Getting started

npx @merkur/create-widget <name>

cd name

npm run dev // Point your browser at http://localhost:4444/

Documentation

To check out live demo and docs, visit https://merkur.js.org.

Contribution

Contribute to this project via Pull-Requests.

We are following Conventional Commits Specification. To simplify the commit process, you can use npm run commit command. It opens an interactive interface, which should help you with commit message composition.

Thank you to all the people who already contributed to Merkur!

merkur's Issues

Incorrect image url

merkur/docs/docs.md

Line 12 in d0c1005

<img class="responsive" src="{{ '/assets/images/merkur-concept.jpg?v=' | append: site.github.build_revision | relative_url }}" alt="Merkur - concept" />

Should change Enzyme to @testing-library due inactivity

create-widget script should reflect view option to ESLint config

Default .eslintrc.js configuration contains:

const config = require('@merkur/tools/eslint.config.js');

module.exports = {
  ...config,
};

But when I choose preact as my view framework the ESLint config should be changed to contain preact specific pragma: 'h'.

Solution 1. - Altter .eslintrc.js contents when creating widget with create-widget script
Solution 2. - Provide multiple ESLint configs in @merkur/tools for each view framework

Error

Hi,

I try use merkur with nodejs v18.x, I have an error:

cross-env NODE_CONFIG_DIR='./server/config' NODE_ENV=development nodemon server/server.js --config nodemon.json

[nodemon] 2.0.19
[nodemon] to restart at any time, enter rs
[nodemon] watching path(s): server//* build//*
[nodemon] watching extensions: cjs,ejs,json,mjs,js,jsx
[nodemon] starting node server/server.js
node:internal/modules/cjs/loader:489
throw e;
^

Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: Package subpath './server/' is not defined by "exports" in ..../node_modules/@merkur/integration/package.json

---

In the module widgetAPI.js:
const { createAssets, memo } = require('@merkur/integration/server/')
It should be replaced by (remove backslash)
const { createAssets, memo } = require('@merkur/integration/server')

Thanks

Feature request: shared, extendable lifecycle methods

With @merkur/plugin-router, the lifecycle methods defined on widgetProperties are ignored in favor of the ones defined for the specific route. It would be neat if they were still executed - especially useful for setting state values that are needed widget-wide, or any other shared lifecycle logic.

Typo

Should be "Merkur uses"

merkur/docs/docs/getting-started.md

Line 85 in d0c1005

Merkur use [config](https://www.npmjs.com/package/config) module for hierarchical configurations for your widget.

widgetProperties.bootstrap() should execute even if a route controller throws an error

Currently, when using @merkur/plugin-router, if the route controller (function supplied as action when defining routes) throws an error, the widgetProperties.bootstrap() method isn't executed. This can be a problem if the method is used e.g. for setting up event listeners.

Dependency core-js is not declared

core package should declare the dependency on core-js package