{"id":16737976,"url":"https://github.com/ahmad-elassuty/rails_graph","last_synced_at":"2025-03-15T13:31:01.277Z","repository":{"id":60554772,"uuid":"535739153","full_name":"ahmad-elassuty/rails_graph","owner":"ahmad-elassuty","description":"Graph visualization for Rails applications","archived":false,"fork":false,"pushed_at":"2024-04-21T19:52:29.000Z","size":54,"stargazers_count":41,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-02-27T01:53:01.021Z","etag":null,"topics":["datamodel","datamodels","dependency","diagram","erd","erdiagram","explorer","graph","interactive","neo4j","rails","ruby"],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/rails_graph","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/ahmad-elassuty.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}},"created_at":"2022-09-12T15:46:50.000Z","updated_at":"2025-01-24T13:37:40.000Z","dependencies_parsed_at":"2024-01-15T21:44:45.327Z","dependency_job_id":"d9a84158-979d-45cc-bbf3-b963c082f57e","html_url":"https://github.com/ahmad-elassuty/rails_graph","commit_stats":{"total_commits":6,"total_committers":1,"mean_commits":6.0,"dds":0.0,"last_synced_commit":"f95c67b252761fcf7a17b0159eef120ad8be13ae"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmad-elassuty%2Frails_graph","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmad-elassuty%2Frails_graph/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmad-elassuty%2Frails_graph/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ahmad-elassuty%2Frails_graph/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ahmad-elassuty","download_url":"https://codeload.github.com/ahmad-elassuty/rails_graph/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243735804,"owners_count":20339532,"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":["datamodel","datamodels","dependency","diagram","erd","erdiagram","explorer","graph","interactive","neo4j","rails","ruby"],"created_at":"2024-10-13T00:28:43.070Z","updated_at":"2025-03-15T13:31:00.836Z","avatar_url":"https://github.com/ahmad-elassuty.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RailsGraph\n\n[![Gem Version](https://badge.fury.io/rb/rails_graph.svg)](https://badge.fury.io/rb/rails_graph)\n\nGraph visualization for Rails applications using [Neo4j Browser](https://neo4j.com/docs/browser-manual/current/). \n\nGain visibility on your Rails application data model and identify bottlenecks. It is an ERD, but interactive and queryable using [Cypher](https://neo4j.com/developer/cypher/).\n\n![Graph](graph.svg \"Graph\")\n\nhttps://github.com/ahmad-elassuty/rails_graph/assets/4674035/53deb04e-f995-4af6-9496-a873f84b5445\n\n## Features\n\n- Application Databases and Tables\n- ActiveRecord Models\n    - Metadata, e.g size, indexes\n    - Columns (disabled by default)\n        - Metadata, e.g type and constraints\n    - Associations\n        - HasMany\n        - BelongsTo\n        - HasOne\n        - HasAndBelongsToMany\n        - Support for Polymorphic Associations\n- ActiveRecord Abstract models\n- Class Hierarchy\n- [Packwerk](https://github.com/Shopify/packwerk) packages (disabled by default)\n- Application Gems (disabled by default)\n\n## Installation\n\nInstall the gem and add to the application's Gemfile by executing:\n\n    $ bundle add rails_graph\n\n## Usage\n\nAfter installing RailsGraph to your Rails application, run the following rake task to scan your app and export it to Neo4j:\n\n```\nrails rails_graph:export:neo4j -- -u neo4j -p admin -h neo4j://localhost:7687\n```\n\nThen explore your model on Neo4j Browser.\n\n### Neo4j\n\nTo learn how to use Neo4j Browser, check out the [documentation](https://neo4j.com/docs/browser-manual/current/visual-tour/).\n\n#### Self setup\nIf you have Neo4j running locally, e.g using Docker, then the browser is most likely accessible through: http://localhost:7474/browser/\n\n#### Cloud Options\nIf you prefer to have a cloud managed server, feel free to check out [Neo4j AuraDB](https://neo4j.com/cloud/platform/aura-graph-database/), it provides a free instance.\n\n## Config\n\nYou can control what RailsGraph will include in the final graph by:\n\n```ruby\n# config/initializers/rails_graph.rb\n\nRailsGraph.configure do |config|\n  # Explicitly define classes that are not loaded automatically\n  config.include_classes = [ActsAsTaggableOn::Tag, ActsAsTaggableOn::Tagging]\n\n  # Enable Columns visualisation\n  # default false\n  config.columns = true\n\n  # Enable Class Hierarchy visualisation\n  # default true\n  config.inheritance = true\n\n  # Enable Databases visualisation\n  # default true\n  config.databases = false\n\n  # Enable Packwerk packages visualisation\n  # default false\n  config.include_packwerk = true\n\n  # Enable Gems visualisation\n  # default false\n  config.gems = true\nend\n```\n\n### Sample Project\n\nCheckout RailsGraph Example repo [here](https://github.com/ahmad-elassuty/rails_graph_example)\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/ahmad-elassuty/rails_graph. 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/ahmad-elassuty/rails_graph/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 RailsGraph project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ahmad-elassuty/rails_graph/blob/master/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmad-elassuty%2Frails_graph","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fahmad-elassuty%2Frails_graph","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fahmad-elassuty%2Frails_graph/lists"}