From d2cb52800f5cfdeb730448214209d0e7b82f2a3b Mon Sep 17 00:00:00 2001 From: Gabriel Castro Date: Fri, 20 Dec 2024 10:50:47 -0300 Subject: [PATCH] :wrench: chore: update docker-compose command to new syntax --- README.md | 12 +++++------- package.json | 16 ++++++++-------- 2 files changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 45772dc0..546959e0 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,6 @@ Midaz Console is a comprehensive solution for managing your Midaz open-source le 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](https://docs.midaz.io/getting-started) for the [Midaz Open-Source Ledger](https://github.com/LerianStudio/midaz) GitHub Logo. For a complete overview of Midaz features, API references, and best practices, visit our [Official Documentation](https://docs.midaz.io). @@ -27,13 +26,12 @@ To start using Midaz Console, you’ll need a running instance of the Midaz Open - Docker: [Docker Installation](https://docs.docker.com/get-docker/) - Docker Compose: [Docker Compose Installation](https://docs.docker.com/compose/install/) - ## Running the Application Locally :warning: **Note:** Ensure that the [Midaz Open-Source Ledger](https://github.com/LerianStudio/midaz) environment is active and accessible, then follow these steps: - 1. Clone the Midaz Console repository: + ```bash git clone https://github.com/LerianStudio/midaz-console.git ``` @@ -48,12 +46,12 @@ 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: + ```bash -npm run docker-compose +npm run docker-up ``` ## Community & Support @@ -65,10 +63,10 @@ npm run docker-compose ## Contributing & License -We welcome contributions from the community! Please read our [Contributing Guidelines](CONTRIBUTING.md) to get started. +We welcome contributions from the community! Please read our [Contributing Guidelines](CONTRIBUTING.md) to get started. Midaz is released under the Apache License 2.0. See the [LICENSE](LICENSE.md) 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 [contact@lerian.io](mailto:contact@lerian.io) or start a Discussion in our [GitHub repository](https://github.com/LerianStudio/midaz-console/discussions). \ No newline at end of file +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 [contact@lerian.io](mailto:contact@lerian.io) or start a Discussion in our [GitHub repository](https://github.com/LerianStudio/midaz-console/discussions). diff --git a/package.json b/package.json index 4287da66..6fbf3e00 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,11 @@ - { - "name": "midaz-console", - "version": "0.1.0", - "private": true, - "repository": { +{ + "name": "midaz-console", + "version": "0.1.0", + "private": true, + "repository": { "type": "git", - "url": "git+https://github.com/LerianStudio/midaz-console.git" - }, + "url": "git+https://github.com/LerianStudio/midaz-console.git" + }, "scripts": { "dev": "next dev -p 8081", "build": "next build", @@ -20,7 +20,7 @@ "test:e2e": "playwright test --ui", "set-local-env": "shx cp .env.local.example .env", "set-env": "shx cp .env.example .env", - "docker-compose": "npm run set-env && docker-compose up -d" + "docker-up": "npm run set-env && docker compose up -d" }, "dependencies": { "@formatjs/intl-localematcher": "^0.5.6",