Skip to content

Latest commit

 

History

History
89 lines (49 loc) · 2.33 KB

README.md

File metadata and controls

89 lines (49 loc) · 2.33 KB

DEPRECATED

DEPRECATED

DEPRECATED

Moved to Mirrorboards

Overview

Mirrorboards is a powerful platform that provides businesses with specialized dashboards tailored to meet their specific needs. Our platform includes a comprehensive set of communication tools that make it easy to integrate different components and streamline your apps. With Mirrorboards, you'll have everything you need to take your business to the next level.

Installation

To install Mirrorboards, you will need to have git and pnpm installed on your system. Follow these steps to install and set up Mirrorboards:

  1. Clone the repository using the following command:

git clone git@github.com:mirrorboards/reflection.git

  1. Install the required dependencies using the following command:

pnpm install

  1. Run the development server using the following command:

pnpm run dev

Installation (Docker)

Follow these steps to set up Mirrorboards services:

  1. Navigate to the root directory:

pnpm run docker:build

pnpm run docker:up

  1. Then you can connect to mongodb with URI

mongodb://luna:crafts@localhost:27017

  1. You can load default mirrorboards seed using command:

pnpm run seed

Components

Mirrorboards consists of several components that work together to provide a comprehensive platform.

mirrorboards

The mirrorboards component is the web application (shell) that serves as the integration point for all services and components.

luna

Luna is a tRPC router that communicates with Auth and Mirrorboards service.

narnia

Luna is a tRPC router that communicates with external APIs.

reflection

The reflection component contains several sub-components that provide specialized UI elements and functionality for Mirrorboards:

  • core: Contains basic UI components and hooks.
  • hooks: Contains specialized hooks for handling commands and the palette.
  • layouts: Contains specialized layouts for creating dashboards.

Dependency graph

Dependency graph

tRPC service authentication flow

  graph TD;
    Narnia[Narnia tRPC]
    Luna[Luna tRPC] --> LunaSDK[Luna SDK]
    Mirrorboards[Mirrorboards tRPC]
    OpenAI[OpenAI tRPC]

    Narnia --> Mirrorboards
    Narnia --> OpenAI

    Mirrorboards --> |request authenticator| Luna --> |return authenticator| Mirrorboards

Loading