https://github.com/mjancarik/merkur

tiny extensible javascript library for front-end microservices
https://github.com/mjancarik/merkur

hyperhtml javascript merkur microfrontends microservices microservices-architecture nodejs preact react svelte uhtml

Last synced: 7 days ago
JSON representation

tiny extensible javascript library for front-end microservices

• Host: GitHub
• URL: https://github.com/mjancarik/merkur
• Owner: mjancarik
• License: mit
• Created: 2020-03-03T22:10:40.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-06-04T18:09:24.000Z (5 months ago)
• Last Synced: 2024-06-09T12:06:33.185Z (5 months ago)
• Topics: hyperhtml, javascript, merkur, microfrontends, microservices, microservices-architecture, nodejs, preact, react, svelte, uhtml
• Language: JavaScript
• Homepage: https://merkur.js.org/
• Size: 11.8 MB
• Stars: 47
• Watchers: 8
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

    

  



# Merkur

[![Build Status](https://github.com/mjancarik/merkur/workflows/CI/badge.svg)](https://github.com/mjancarik/merkur/actions/workflows/ci.yml)

[![NPM package version](https://img.shields.io/npm/v/@merkur/core/latest.svg)](https://www.npmjs.com/package/@merkur/core)

![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/minzip/@merkur/core/latest)

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

The [Merkur](https://merkur.js.org/) 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](https://preactjs.com/), [µhtml](https://github.com/WebReflection/uhtml#readme), [Svelte](https://svelte.dev/) and [vanilla](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Template_literals) 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

```bash

npx @merkur/create-widget 

cd name

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

```

![alt text](https://raw.githubusercontent.com/mjancarik/merkur/master/images/hello-widget.png "Merkur example, hello widget")

## Documentation

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

## Contribution

Contribute to this project via [Pull-Requests](https://github.com/mjancarik/merkur/pulls).

We are following [Conventional Commits Specification](https://www.conventionalcommits.org/en/v1.0.0/#summary). 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!