Ecosyste.ms: Awesome

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

https://github.com/amatsuda/erd

A Rails engine for drawing your app's ER diagram
https://github.com/amatsuda/erd

database database-management database-migrations database-schema engine erdiagram rails

Last synced: 29 days ago
JSON representation

A Rails engine for drawing your app's ER diagram

Host: GitHub
URL: https://github.com/amatsuda/erd
Owner: amatsuda
License: mit
Created: 2012-04-27T05:08:35.000Z (over 12 years ago)
Default Branch: master
Last Pushed: 2024-02-28T01:38:58.000Z (9 months ago)
Last Synced: 2024-10-04T03:56:44.086Z (about 1 month ago)
Topics: database, database-management, database-migrations, database-schema, engine, erdiagram, rails
Language: Ruby
Homepage:
Size: 473 KB
Stars: 331
Watchers: 12
Forks: 41
Open Issues: 8
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE

# Erd

A Rails engine for drawing your app's ER diagram and operating migrations

## Requirements

* Rails 7.0, 6.1, 6.0, 5.2, 5.1, 5.0, 4.2, 4.1, 4.0, 3.2, or 3.1

* Graphviz

## Installation

Bundle 'erd' gem to your existing Rails app's Gemfile:
```ruby
gem 'erd', group: :development

```

## Usage

Browse at your http://localhost:3000/erd

## Features

### Show Mode

* Erd draws an ER diagram based on your app's database and models.

* You can drag and arrange the positions of each model.

* Then you can save the positions to a local file `db/erd_positions.json`, so you can share the diagram between the team members.

### Edit Mode

* You can operate DB schema manipulations such as `add column`, `rename column`, `alter column`, `create model (as well as table)`, and `drop table`.

* Then, Erd generates migration files on the server.

* And you can run each migration on your browser super quickly.

## TODO

* Fix buggy JS

* drop column (need to think of the UI)

* stop depending on Graphviz

* tests

* cleaner code (the code is horrible. Please don't read the code, though of course your patches welcome)

## Contributing to Erd

* Send me your pull requests!

## Team

* [Akira Matsuda][https://github.com/amatsuda]
* [Teppei Machida][http://github.com/machida] (design)