https://github.com/rapid7/metasploit-erd

Extensions to rails-erd to find clusters of models to generate subdomains specific to each model.
https://github.com/rapid7/metasploit-erd

Last synced: over 1 year ago
JSON representation

Extensions to rails-erd to find clusters of models to generate subdomains specific to each model.

• Host: GitHub
• URL: https://github.com/rapid7/metasploit-erd
• Owner: rapid7
• License: bsd-3-clause
• Created: 2014-04-21T14:09:34.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2025-02-13T14:46:55.000Z (over 1 year ago)
• Last Synced: 2025-04-13T00:44:16.473Z (over 1 year ago)
• Language: Ruby
• Size: 181 KB
• Stars: 4
• Watchers: 61
• Forks: 10
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Metasploit::ERD [![Build Status](https://github.com/rapid7/metasploit-erd/actions/workflows/verify.yml/badge.svg)](https://github.com/rapid7/metasploit-erd/actions/workflows/verify.yml)[![Code Climate](https://codeclimate.com/github/rapid7/metasploit-erd.png)](https://codeclimate.com/github/rapid7/metasploit-erd)[![Coverage Status](https://coveralls.io/repos/rapid7/metasploit-erd/badge.png)](https://coveralls.io/r/rapid7/metasploit-erd)[![Dependency Status](https://gemnasium.com/rapid7/metasploit-erd.png)](https://gemnasium.com/rapid7/metasploit-erd)[![Gem Version](https://badge.fury.io/rb/metasploit-erd.png)](http://badge.fury.io/rb/metasploit-erd)

Traces the `belongs_to` associations on `ActiveRecord::Base.descendants` to find the minimum cluster in which all

foreign keys are fulfilled in the Entity-Relationship Diagram.'

## Versioning

`Metasploit::ERD` is versioned using [semantic versioning 2.0](http://semver.org/spec/v2.0.0.html).  Each branch

should set `Metasploit::ERD::Version::PRERELEASE` to the branch name, while master should have no `PRERELEASE`

and the `PRERELEASE` section of `Metasploit::ERD::VERSION` does not exist.

## Installation

### Gem

Add this line to your application's Gemfile:

    gem 'metasploit-erd'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install metasploit-erd

### System tools

In order to generate the diagrams as PNGs, graphviz is used, which may have issues when use on OSX Mavericks.  If you

get 'CoreTest performance note' messages when running 'rake yard', you should reinstall graphviz as follows:

`brew reinstall graphviz --with-bindings --with-freetype --with-librsvg --with-pangocairo`.

## Usage

TODO: Write usage instructions here

## Contributing

1. Fork it ( http://github.com//metasploit-erd/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request