Installation

This guide covers the installation of embed-dossier-mstr-react.

To install this embed-dossier-mstr-react package, you need to have several prerequisites in place. Here's a list of all the essential pre-requisites you need to have before installing the package:

Prerequisites

1

System Requirements

  • Node.js: Make sure you have Node.js installed. The project uses npm, which comes with Node.js. Install Node.js from here.
  • NPM or Yarn: Since the project uses npm commands, ensure that npm is installed with Node.js. Alternatively, you can use Yarn if preferred.

To verify installation, run:

node -v
npm -v
2

Code Editor

You’ll need a code editor to work on the project. Common options include:

3

Required Knowledge

  • Next.js: Since this is a Next.js project, you should be familiar with Next.js basics.
  • React: The project uses React, so understanding React's component structure and hooks will help.
  • TypeScript: The project is written in TypeScript, so you should have a basic understanding of it.

Installation

To install the package, you can use npm or yarn. Run the following command to install the package:

npm install embed-dossier-mstr-react

Simple Usage

To use the package in simply way, you need to import the DashboardEmbed component from the package and use it in your project. Here's a simple example of how you can use the package:

import { DashboardEmbed } from "embed-dossier-mstr-react"

const MinimalTemplateEmbed = () => {
  return (
    <>
      <DashboardEmbed
        dossierUrl="your-dossier-url"
        style={{
          width: "1000px",
          height: "1200px",
        }}
      />
    </>
  )
}

export default MinimalTemplateEmbed

Important Information

Configuration: You need to configure the package with your MicroStrategy environment details. Refer to the package documentation for more information.