ostaptan/varvara

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# Varvara v1.0.2 [![Code Climate](https://codeclimate.com/github/ostaptan/varvara.png)](https://codeclimate.com/github/ostaptan/varvara)

Displays your routes, controllers, models, their columns associations and their methods & variables. Provides full stack of hierarchy, dependencies, associations of your project.

![Routes:](https://www.evernote.com/shard/s221/sh/641b071e-8178-4332-9bc3-5df1b413a0be/922e34563fed6e41db664350a93c054d/deep/0/Screenshot%2029.09.13%2018:14.jpg)
![Models:](https://www.evernote.com/shard/s221/sh/9ada483e-3db6-4315-a9be-9b65d4c9bc85/cb9768c4cbef6c228058ccd690553a01/deep/0/Screenshot%2029.09.13%2016:36.jpg)
![Controllors:](https://www.evernote.com/shard/s221/sh/fb141c86-0c2e-42a7-8cc8-5b69245f70e6/2505fc0fc8d3a7e88e446620129ccd69/deep/0/Screenshot%2029.09.13%2018:16.jpg)

## Installation

Add this line to your application's Gemfile:

    group :development do
        gem 'varvara'
    end    

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install varvara

## Usage

For current version visit `localhost:3000/varvara` in your app and see full stack of hierarchy, dependencies, associations, routes, controllers, models and configurations of your project.    

## Contributing

1. Fork it
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

## What to do?

1. Add some stylings and improve the view of pages (add some javascript for models as erd of akira matsuda https://github.com/amatsuda/erd )
2. Add hierarchy of controllers.
3. maybe: Live rails console as in gem 'better_errors'
4. Add displaying some configurations.
5. Add ui possibillity to generate models, controllers, scaffolds.
6. have fun)