Midaz Console is an all-in-one solution for managing your Midaz open-source ledger. It is designed to simplify user operations and enhance routine tasks on the Midaz platform.

Prerequisites

❗️

Important

Before beginning the setup of Midaz Console, you must setup the Midaz Ledger and make sure it is running.

After setting up the Midaz ledger, you must also make sure that the following tolls are installed:

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

Once you've completed the installation of all tools, you can download the code for the Console and proceed with setting up the Midaz Console.

Setting up Midaz Console

After making sure that the Midaz Ledger is active, follow these steps to run the application on your local machine:

Step 1 - Clone the Midaz Console repository

git clone https://github.com/LerianStudio/midaz-console.git
cd midaz-console

Step 2 - Configure and start the local console

Run the commands below to configure and start the local console stack.

npm install
npm run set-local-env
npm run dev

Step 3 - Access Midaz Console

After setting up your local environment, you should be able to quickly access and test Midaz Console using the following port: http://localhost:8081.

📘

First deployment

If you are deploying Midaz Console for the first time, the Console might take a bit longer to compile the information.

Step 4 - Deploy on Docker (optional)

Execute the npm script to prepare and deploy the application on docker.

npm run docker-up

Community & Support

• 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

We welcome contributions from the community! Please read our Contributing Guidelines to get started.

Midaz is released under the Apache License 2.0. See the LICENSE for more details. This license allows you to use, modify, and distribute Midaz, provided you include the original copyright and license.