Guides

Installing Midaz Console

Suggest Edits

Midaz Console is a visual interface that helps you manage your Midaz open-source Ledger with ease. Whether you're just getting started or looking for a simpler way to handle day-to-day operations, this guide will walk you through how to install and run Midaz Console, even if you’ve never used a terminal before.

Let’s take it one step at a time.


Prerequisites

Before installing Midaz Console, make sure a few things are ready:

❗️

Important

You must set up the Midaz Ledger and make sure it is running before you beging instaling Midaz Console.


You’ll need two tools installed on your computer:

  • Node.js (version 18.x or higher)
  • NPM (it comes with Node.js)

👍

First time using Node.js or npm?

No problem, we've got you covered. If you're new to these tools or not sure how to install them, check out our Beginner-Friendly Guide to Node.js and npm. It walks you through everything step by step.

Once those are installed, you’re ready to go.


Setting up Midaz Console

🚧

Attention

Check Docker Desktop to make sure the Midaz Ledger is running. The Console won’t work without it.


Step 1 - Download the Console code

First, you’ll download a copy of Midaz Console to your computer.

  1. Open your terminal or command prompt.
  2. Navigate to the folder where you want to keep the project. For example, if you want to save it to your Desktop, you can run:
    1. On Windows, it might look like cd %USERPROFILE%\Desktop.
cd ~/Desktop
  1. Download the repository by running the following command:
    1. This will create a folder called midaz-console and place all the Console files inside it.
git clone https://github.com/LerianStudio/midaz-console.git
  1. Navigate to the midaz-console folder to continue the setup from there. To do so, run the following command:
cd midaz-console

Step 2 - Set up and run Midaz Console locally

Now that you’ve downloaded the Console code to your computer, let’s set it up.

  1. Install all required dependencies by running this command:
npm install
  1. Configure your local environment by running this next command:
npm run set-local-env
  1. Start the Console by running this command:
    1. This may take a few minutes the first time. That’s expected.
npm run dev

Step 3 - Open Midaz Console in your browser

Once the setup is complete, open your browser and go to: http://localhost:8081.

👍

First time running the Console?

It might take a little longer to load while it compiles and displays the data.


Step 4 - Optional: Run with Docker

If you prefer to run everything in containers (a good way to keep your system clean and isolated), you can use Docker. Just run:

npm run docker-up


Community & Support

We’re here to help, and we’d love to hear from you.

  • Join our Discord community for discussions, support, and updates.
  • For bug reports and feature requests, please use our GitHub Issues.
  • To share ideas or discuss topics with the community, start a Discussion on our GitHub.
  • Follow us on Twitter for news and announcements.

Contributing & License

Midaz is open source, and we welcome your contributions.

Updated 29 days ago