Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nelsonsilva/yUMLmeRails

Use yUML to generate Rails diagrams using RailRoad and Shoes
https://github.com/nelsonsilva/yUMLmeRails

Last synced: 5 days ago
JSON representation

Use yUML to generate Rails diagrams using RailRoad and Shoes

Awesome Lists containing this project

README

        

Fork from [dmitry](http://github.com/dmitry/yUMLmeRails/) < [nelsonsilva](http://github.com/nelsonsilva/yUMLmeRails/) to adapt/improve some things (according to my working style).

# yUMLmeRails

This is a simple plugin that adds Rake tasks to display model diagrams for RoR apps.

It uses an extended RailRoad to output yUML diagrams which are drawn using the service at [yUML](http://yuml.me)

There's also a small Shoes app to display the downloaded diagram.

## Example

## Requirements

* Shoes (if you want to use the show-task)
* Rake >= 0.8.0 (or remove the 'arg' in the rake task yUMLmeRails:download)

## Installation

* Just clone this into vendor/plugins

## Usage (rake -T)

* rake yUMLmeRails:download # Download yUML model diagram to doc/diagrams
* rake yUMLmeRails:show # Show model diagram
* rake yUMLmeRails:url # Get yUML URL

Feel free to do whatever you want with the code but please share your results with us.