Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔧 chore: update docker-compose command to new syntax #96

Merged
merged 1 commit into from
Dec 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) <img src="https://github.com/favicon.ico" width="20" height="20" alt="GitHub Logo">. For a complete overview of Midaz features, API references, and best practices, visit our [Official Documentation](https://docs.midaz.io).
Expand All @@ -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
```
Expand All @@ -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
Expand All @@ -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).
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).
16 changes: 8 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand All @@ -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",
Expand Down
Loading