Run The Example Application

In a Docker container (2min)

Prerequisites

Note for this to work you need to have Docker installed on your machine.

Build and run the application

Please set your environment variables in an .env file in the project root.

cp .env.example .env

Then, start the docker container:

docker compose up --build

This will expose the application on the host machine port specified in the env file (:1618 by default).

Building the application locally (5min)

Prerequisites

Note for this you need Node and PNPM installed on your machine.

Build an run the application

There are two versions of the application available to play with:

• The base application - a bare bones app with minimal styling.
• The example implementation - a themed version of the application.

Set the application specific .env variables in the application.

cp app/base/.env.example app/base/.env # or in app/example

Install the packages:

pnpm install

Build and run the application for development:

pnpm --filter @visualizevalue/mint-app-base dev

Open the locally running app in your browser.

You can always download fork/download the code for the base application like above and customize it directly. While this is easy and quick to start it is not the preferred way to build a custom version of the app since it comes with drawbacks when maintaining it over the long term.

Let's look at our preferred way to customize Mint applications – extending the base application via "Layers".