{"id":13408936,"url":"https://github.com/VortX-DAO/mxbi","last_synced_at":"2025-03-14T13:32:12.053Z","repository":{"id":176560674,"uuid":"639372399","full_name":"VortX-DAO/mxbi","owner":"VortX-DAO","description":null,"archived":false,"fork":false,"pushed_at":"2023-08-16T04:00:28.000Z","size":187,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2024-09-28T20:47:24.293Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/VortX-DAO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-11T10:40:05.000Z","updated_at":"2023-07-30T15:59:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"208d2651-15e7-4c91-80f4-1d3dd2740da1","html_url":"https://github.com/VortX-DAO/mxbi","commit_stats":null,"previous_names":["vortx-dao/mxbi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VortX-DAO%2Fmxbi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VortX-DAO%2Fmxbi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VortX-DAO%2Fmxbi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/VortX-DAO%2Fmxbi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/VortX-DAO","download_url":"https://codeload.github.com/VortX-DAO/mxbi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243584515,"owners_count":20314777,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T20:00:56.728Z","updated_at":"2025-03-14T13:32:12.042Z","avatar_url":"https://github.com/VortX-DAO.png","language":"TypeScript","funding_links":[],"categories":["MultiversX community"],"sub_categories":["SDKs and dev tools"],"readme":"## mxbi - Generate Backend for MX Smart Contract Endpoints\n\nmxbi is a command-line interface (CLI) tool that generates backend code for MX smart contract endpoints. The tool generates TypeScript code that can be used to implement the server-side logic for smart contract endpoints.\n\n### Installation\n\nTo install mxbi, run the following command:\n\n```bash\nnpm install -g @vortx/mxbi\n```\n\nThis will install the tool globally on your system.\n\n### Usage\n\nTo use mxbi, run the following command:\n\n```bash\nmxbi generate-backend --contractPath \u003ccontractPath\u003e [--skip-build]\n```\n\nThe following options are available:\n\n- `-c, --contractPath \u003ccontractPath\u003e`: The path to your directory containing the smart contracts. This is a required option.\n\n- `-s, --skip-build`: If included, mxbi will skip the build process. This option is optional and defaults to `false` if not provided.\n\nFor example, to generate endpoint code for a directory of smart contracts located at `./contracts/`, you would run the following command:\n\n```bash\nmxbi generate-backend --contractPath ./contracts/\n```\n\n### Building and Running the Tool\n\nTo build and run the tool, use the following commands:\n\n```bash\nnpm run build \u0026\u0026 cd lib \u0026\u0026 npm link \u0026\u0026 chmod +x /opt/homebrew/bin/mxbi\n```\n\nThis will build the tool, create a symbolic link to the tool in the `/opt/homebrew/bin` directory, and set executable permissions, which allows you to run the tool by typing `mxbi` in the command line.\n\n### Issues\n\nIf you encounter any issues while using mxbi, please file an issue in the GitHub repository.\n\n### Contributing\n\nContributions to mxbi are always welcome. If you're interested in contributing, please fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.\n\n### License\n\nmxbi is released under the MIT License. See the `LICENSE` file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVortX-DAO%2Fmxbi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FVortX-DAO%2Fmxbi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FVortX-DAO%2Fmxbi/lists"}