Midaz Console: Simplify Management of Your Next-Gen Open-Source Ledger

Midaz Console is a comprehensive solution for managing your Midaz open-source ledger. With the Console, you can efficiently oversee and handle all operations related to Midaz through an intuitive interface.

The Midaz Open-Source Ledger offers flexible management options via APIs, gRPC, and CLI. Midaz Console is purpose-built to simplify user operations and streamline routine tasks on the Midaz platform.

Getting Started

To start using Midaz Console, you’ll need a running instance of the Midaz Open-Source Ledger. Please follow our Getting Started Guide for the Midaz Open-Source Ledger . For a complete overview of Midaz features, API references, and best practices, visit our Official Documentation.

Prerequisites

• Midaz Open-Source Ledger
• Node.js (Version: >=18.x)
• npm
• Docker: Docker Installation
• Docker Compose: Docker Compose Installation

Running the Application Locally

⚠️ Note: Ensure that the Midaz Open-Source Ledger environment is active and accessible, then follow these steps:

1. Clone the Midaz Console repository:

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

2. Run the following commands to configure and start the local console stack:

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

3. Open http://localhost:8081 in your browser to verify that Midaz Console is running.

Deploying with Docker

To deploy Midaz Console in a Docker environment, execute the following npm script:

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.

About Lerian

Midaz is developed by Lerian, a technology company founded in 2023 by a team with extensive experience in ledger and core banking solutions. For inquiries or support, contact us at [email protected] or start a Discussion in our GitHub repository.