diff --git a/.gitignore b/.gitignore index 9b98da44..b10a9435 100644 --- a/.gitignore +++ b/.gitignore @@ -42,6 +42,7 @@ next-env.d.ts *storybook.log # Storybook +.storybook /storybook-static/ # Playwright diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index 7abb13d0..00000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,7 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml -# Editor-based HTTP Client requests -/httpRequests/ -# GitHub Copilot persisted chat sessions -/copilot/chatSessions diff --git a/.idea/aws.xml b/.idea/aws.xml deleted file mode 100644 index 03f1bb6e..00000000 --- a/.idea/aws.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - \ No newline at end of file diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml deleted file mode 100644 index 9d559839..00000000 --- a/.idea/codeStyles/Project.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/codeStyles/codeStyleConfig.xml b/.idea/codeStyles/codeStyleConfig.xml deleted file mode 100644 index 79ee123c..00000000 --- a/.idea/codeStyles/codeStyleConfig.xml +++ /dev/null @@ -1,5 +0,0 @@ - - - - \ No newline at end of file diff --git a/.idea/dbnavigator.xml b/.idea/dbnavigator.xml deleted file mode 100644 index 1d77cff0..00000000 --- a/.idea/dbnavigator.xml +++ /dev/null @@ -1,407 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/.idea/midaz-console.iml b/.idea/midaz-console.iml deleted file mode 100644 index 068b1b95..00000000 --- a/.idea/midaz-console.iml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml deleted file mode 100644 index 7a3a8864..00000000 --- a/.idea/modules.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml deleted file mode 100644 index 35eb1ddf..00000000 --- a/.idea/vcs.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.storybook/main.ts b/.storybook/main.ts deleted file mode 100644 index d5602a14..00000000 --- a/.storybook/main.ts +++ /dev/null @@ -1,58 +0,0 @@ -import type { StorybookConfig } from '@storybook/nextjs' - -const config: StorybookConfig = { - stories: [ - '../src/components/**/*.mdx', - '../src/components/**/*.stories.@(js|jsx|mjs|ts|tsx)' - ], - staticDirs: ['../public'], - addons: [ - '@storybook/addon-onboarding', - '@storybook/addon-links', - '@storybook/addon-essentials', - '@chromatic-com/storybook', - '@storybook/addon-interactions', - '@storybook/addon-styling-webpack', - - { - name: '@storybook/addon-styling-webpack', - options: { - rules: [ - { - test: /\.css$/, - sideEffects: true, - use: [ - require.resolve('style-loader'), - { - loader: require.resolve('css-loader'), - options: { - importLoaders: 1 - } - }, - { - loader: require.resolve('postcss-loader'), - options: { - implementation: require.resolve('postcss') - } - } - ] - } - ] - } - } - ], - - framework: { - name: '@storybook/nextjs', - options: {} - }, - typescript: { - reactDocgen: 'react-docgen-typescript' - }, - docs: { - autodocs: 'tag' - }, - staticDirs: ['..\\public'], - build: {} -} -export default config diff --git a/.storybook/preview.tsx b/.storybook/preview.tsx deleted file mode 100644 index d7963faa..00000000 --- a/.storybook/preview.tsx +++ /dev/null @@ -1,34 +0,0 @@ -import type { Preview } from '@storybook/react' - -import '../src/app/globals.css' - -import React from 'react' -import { ThemeProvider } from '../src/lib/theme/theme-provider' -import { IntlProvider } from 'react-intl' - -const preview: Preview = { - parameters: { - backgrounds: { - values: [{ name: 'Light', value: '#f4f4f5' }], - default: 'Light' - }, - controls: { - matchers: { - color: /(background|color)$/i, - date: /Date$/i - } - } - } -} - -export const decorators = [ - (Story) => ( - - - - - - ) -] - -export default preview diff --git a/README.md b/README.md index c7f8f080..45772dc0 100644 --- a/README.md +++ b/README.md @@ -8,48 +8,50 @@ -## Midaz Console: Easy Management your Next-Gen Open-Source Ledger +## Midaz Console: Simplify Management of Your Next-Gen Open-Source Ledger -Midaz console is a solution built to manage your midaz open-source ledger, with midaz console, you will be able to manage your entire operation related to Midaz in a simple and intuitive way. +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. -Midaz Open-Source Ledger allows you to manage using API's, GRCP, CLI. The Midaz Console was designed for the operation of its users, facilitating all the work to be carried out on Midaz on a daily basis. +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 Start -To begin using Midaz console, you need to had a Midaz Open-Source Ledger running. Please follow our [Getting Started Guide](https://docs.midaz.io/getting-started) of [Midaz Open-Source Ledger](https://github.com/LerianStudio/midaz) GitHub Logo. For comprehensive documentation on Midaz features, API references, and best practices, visit our [Official Documentation](https://docs.midaz.io). +## 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). ### Prerequisites -- [Midaz Open-Source Ledger](https://github.com/LerianStudio/midaz) GitHub Logo +- [Midaz Open-Source Ledger](https://github.com/LerianStudio/midaz) GitHub Logo - Node.js (Version: >=18.x) -- NPM +- npm - Docker: [Docker Installation](https://docs.docker.com/get-docker/) - - Docker Compose: [Docker Compose Installation](https://docs.docker.com/compose/install/) -## Steps to run the application locally -:warning: Before proceeding, please ensure that the [Midaz Open-Source Ledger](https://github.com/LerianStudio/midaz) environment is active and available. +## Running the Application Locally -Clone midaz console repository +: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 ``` -Run the commands below to configure and start the local console stack. +2. Run the following commands to configure and start the local console stack: ```bash +npm install npm run set-local-env npm run dev ``` -Open [http://localhost:8081](http://localhost:8081) with your browser to confirm that Midaz Console is up +3. Open http://localhost:8081 in your browser to verify that Midaz Console is running. -## Deploy on Docker -Execute npm script to prepare and deploy application on docker +## Deploying with Docker +To deploy Midaz Console in a Docker environment, execute the following npm script: ```bash npm run docker-compose ``` @@ -58,13 +60,15 @@ npm run docker-compose - Join our [Discord community](https://discord.gg/DnhqKwkGv3) for discussions, support, and updates. - For bug reports and feature requests, please use our [GitHub Issues](https://github.com/LerianStudio/midaz-console/issues). -- If you want to raise anything to the attention of the community, open a Discussion in our [GitHub](https://github.com/LerianStudio/midaz-console/discussions). -- Follow us on [Twitter](https://twitter.com/LerianStudio) for the latest news and announcements. +- To share ideas or discuss topics with the community, start a Discussion on our [GitHub](https://github.com/LerianStudio/midaz-console/discussions). +- Follow us on [Twitter](https://twitter.com/LerianStudio) for news and announcements. ## Contributing & License -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 [LICENSE](LICENSE.md) for more information. In a nutshell, this means you can use, modify, and distribute Midaz as you see fit, as long as you include the original copyright and license notice. +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 tech company founded in 2023, led by a team with a track record in developing ledger and core banking solutions. For any inquiries or support, please reach out to us at [contact@lerian.io](mailto:contact@lerian.io) or simply open 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). \ No newline at end of file