{"id":15211770,"url":"https://github.com/martinnicolas/interactors_mindmap","last_synced_at":"2025-07-20T16:33:32.077Z","repository":{"id":242163004,"uuid":"805947893","full_name":"martinnicolas/interactors_mindmap","owner":"martinnicolas","description":"Mindmap chart for your Rails interactors","archived":false,"fork":false,"pushed_at":"2025-04-19T02:25:20.000Z","size":97,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-22T12:49:34.447Z","etag":null,"topics":["mindmap","rails","rails-interactors","ruby"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/martinnicolas.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null}},"created_at":"2024-05-25T23:31:11.000Z","updated_at":"2025-04-19T02:25:05.000Z","dependencies_parsed_at":"2024-06-01T02:45:53.177Z","dependency_job_id":"d53aaef4-0220-45a0-9feb-a18576d444a0","html_url":"https://github.com/martinnicolas/interactors_mindmap","commit_stats":null,"previous_names":["martinnicolas/interactors_mindmap"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/martinnicolas/interactors_mindmap","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinnicolas%2Finteractors_mindmap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinnicolas%2Finteractors_mindmap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinnicolas%2Finteractors_mindmap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinnicolas%2Finteractors_mindmap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/martinnicolas","download_url":"https://codeload.github.com/martinnicolas/interactors_mindmap/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/martinnicolas%2Finteractors_mindmap/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266160768,"owners_count":23885884,"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":["mindmap","rails","rails-interactors","ruby"],"created_at":"2024-09-28T09:00:41.190Z","updated_at":"2025-07-20T16:33:32.045Z","avatar_url":"https://github.com/martinnicolas.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# InteractorsMindmap\n\n[![Tests](https://github.com/martinnicolas/interactors_mindmap/actions/workflows/main.yml/badge.svg)](https://github.com/martinnicolas/interactors_mindmap/actions/workflows/main.yml)\n[![Gem Version](https://badge.fury.io/rb/interactors_mindmap.svg?icon=si%3Arubygems\u0026icon_color=%23ef2929)](https://badge.fury.io/rb/interactors_mindmap)\n[![Gem Total Downloads](https://img.shields.io/gem/dt/interactors_mindmap)](https://rubygems.org/gems/interactors_mindmap)\n[![Wercker](https://img.shields.io/github/license/mashape/apistatus.svg)](https://opensource.org/licenses/MIT)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)\n\nThis gem generates a mindmap chart to document your [interactors](https://github.com/collectiveidea/interactor) flow on your Ruby on Rails application.\n\n![example](https://raw.githubusercontent.com/martinnicolas/interactors_mindmap/master/spec/fixtures/assets/test.png)\n\n## Installation\n\nInstall the gem and add to the application's Gemfile by executing:\n\n    $ bundle add interactors_mindmap\n\nIf bundler is not being used to manage dependencies, install the gem by executing:\n\n    $ gem install interactors_mindmap\n\n## Usage\n\nRun `interactors_mindmap` on the root path of your RoR application to generate an interactors mindmap chart.\n\n### Running with options\n\nBy default running `interactors_mindmap`, without arguments, will show you the usage information message. You can use different options to run `interactors_mindmap` and generate only the files what you need:\n\n- `interactors_mindmap --all`: This will generate the `interactors.md` and `interactors.html` files.\n- `interactors_mindmap --md`: This will generate only the `interactors.md` file.\n- `interactors_mindmap --html`: This will generate only the `interactors.html` file.\n- `interactors_mindmap --version`: This will show the gem version.\n- `interactors_mindmap --help`: This will show a usage information message.\n\nThis gem use [https://markmap.js.org/](https://markmap.js.org/) to generate your interactors mindmap chart.\nOpen `interactors.html` generated file to see your interactors mindmap chart on your browser. Alternatively, if you use Visual Studio Code IDE you can install [markmap](https://marketplace.visualstudio.com/items?itemName=gera2ld.markmap-vscodemd`) extension to open `interactors.md` generated file on the IDE.\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/martinnicolas/interactors_mindmap. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/martinnicolas/interactors_mindmap/blob/master/CODE_OF_CONDUCT.md).\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n## Code of Conduct\n\nEveryone interacting in the InteractorsMindmap project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/martinnicolas/interactors_mindmap/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartinnicolas%2Finteractors_mindmap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmartinnicolas%2Finteractors_mindmap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmartinnicolas%2Finteractors_mindmap/lists"}