This guide walks you through the steps to set up and run your Midaz All-in-One Suite, with clear instructions for users of all technical backgrounds.

Prerequisites

Before starting, ensure the following tools and resources are ready on your machine:

1. System Requirements

• Operating System:
  • Windows: Windows 10 version 2004 and higher (Build 19041 and higher).
  • macOS: the current release of macOS and the previous two releases.
  • Linux: Ubuntu, Debian, Red Hat Enterprise Linux or Fedora
• RAM: At least 8 GB is recommended for running Docker.
• Disk Space: 20 GB of free storage for containers and data.
• Internet: A stable internet connection for downloading tools and dependencies.
• Browser: Use a modern browser like Google Chrome or Firefox for accessing services like Grafana.

2. Tools You Need

• Git: Installation Guide
• Docker Desktop: Installation Guide
• Postman (recommended): Download POSTMAN
• Chocolatey Package Manager: Installation Guide

3. Enable the make command

After installing Chocolatey, you must run the following command to install the make function:

sudo apt install make

brew install make

choco install make

Setting Up the Midaz All-in-One Suite

Here’s how to set it up:

1. Clone the Repository

1. Open a terminal or command prompt.
2. Clone the Midaz stack repository:

git clone --recurse-submodules [email protected]:LerianStudio/midaz-stack.git
cd midaz-stack

2. Start the All-in-One Suite

Run the following command to launch the unified stack:

make up

3. Stop the All-in-One Suite

To stop the suite, use:

make stop

4. Remove the All-in-One Suite

To clean up and remove the suite:

make remove

Next Steps

Once your setup is complete, you can:

1. Explore APIs: Use the Postman collection in the postman folder of your repository or download it here.
2. Authenticate: Follow the Authentication Guide to start using Midaz services.
3. Build Your First Structure: Check out the Quick Start Guide to create your first Midaz Structure.

Need Help?

If you have questions or encounter issues, we’re here to help:

• Contribution Guidelines: Learn how to contribute to the Midaz project here.
• Join the Community: Connect with us on Discord.
• Open Issues: Find beginner-friendly issues to contribute to or propose your own.

Together, let’s build the future of ledger management!