Run the dashboard locally

1. 01

   Download your template

   Open My templates in your Aniq UI dashboard and download the ZIP.

   • My templates

   0:00 / 0:07

   Expected result: A file named like dashboard-template-1-main-….zip is in your downloads.

   I've done this step
2. 02

   Unzip and open the folder

   Extract the ZIP and open a terminal in the dashboard-template-1 folder. On Windows, extract it in File Explorer, then open a terminal in the folder.

   TerminalCopy

   unzip dashboard-template-1-*.zip
   cd dashboard-template-1

   0:00 / 0:08

   Expected result: The folder lists Dockerfile, package.json, messages, public and src.

   Having trouble?

   I've done this step
3. 03

   Build the image

   Docker installs the dependencies and builds the dashboard inside the image. The first build takes a few minutes and needs an internet connection; later builds reuse what did not change.

   Terminalin dashboard-template-1Copy

   docker build -t financial-dashboard .

   0:00 / 0:08

   Expected result: The build ends with a line naming the image financial-dashboard.

   Having trouble?

   I've done this step
4. 04

   Start it and open the dashboard

   Start a container from the image, then open localhost:3030/en/loginLocal. Leave the terminal open while you use it.

   Terminalin dashboard-template-1Copy

   docker run -p 3030:3030 financial-dashboard

   A port is already in use?

   If the start stops with port is already allocated or address already in use, another program uses port 3030. Either stop it, or change the number on the left of -p and open that port instead: docker run -p 3041:3030 financial-dashboard, then localhost:3041Local.

   A port is already in use

   0:00 / 0:13

   Expected result: The sign-in page opens in English. Sign in with the details below and the overview opens.

   Having trouble?

   I've done this step

Sign in

The dashboard ships with one account:

The account is a placeholder, checked in your browser. Replace it with your own sign-in before you go live.

• How the sign-in works

Stop and start again

Press Ctrl+C in the terminal to stop the dashboard. If you closed that terminal, find the container and stop it:

docker ps
docker stop <container-id>

Use the ID that docker ps lists for financial-dashboard. To start again, run the same docker run command; the image is already built.

After you change a file, build the image again before you run it. The image holds a copy of the code from when it was built.

Your own settings

The settings are compiled into the app when the image is built, so they are build arguments, not docker run options. For example, to build with demo mode on:

docker build -t financial-dashboard --build-arg NEXT_PUBLIC_DEMO_MODE=true .

• What each setting does

Next

• Make it your brand
• Run it without Docker
• Put it online