Skip to content

Spellbook

ng-druid edited this page Mar 11, 2022 · 22 revisions

Terminology

Spell

Independent repository containing plugins for druid core. For example, a repository that adds charting capabilities to druid editor without hacking core. Also can be referred to as an extension.

Spellbook

Druid marketplace for marketing, discovering, development research, etc. of spells. Users will be able to search for spells and install on various environments local, remote easily.

Environments

There are multiple ways to use druid depending on programming capabilities and needs.

Stand Alone

Stand alone Angular project with specific druid core modules installed. This option offers the most flexibility and full control over the Angular project. However, this option requires knowledge of Angular and Version Control. Best option for programmers who want complete control over a single project without micro-frontends containing everything in a single monolithic front-end.

Core Only

Druid core can be cloned into a local repo on a machine. The libs can be installed and project ran using standard Angular commands or nx console in vs code. However, this option should only be used when using micro-frontends and spells to build pages. Core should never be hacked. Furthermore, to easily get up and running developers can begin with core and migrate to stand alone when the need arises.

Docker

Docker container with image of core. Effectively a core only solution but containerized instead of running on a host machine.

Cloud

Cloud hosted druid core or stand alone for an organization. Stand alone solution can be modified directly in the browser using containerization. Spells can be automatically installed from the spellbook to a target druid project owned by the organization by a person with the proper permissions to execute the operation.

Demos

Easily host demos for projects using module federation. Druid can be used as shell app that contains the external micro-frontend app.

Clone this wiki locally