Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1014 Bytes

README.md

File metadata and controls

28 lines (21 loc) · 1014 Bytes

erd-rs

Rust CLI tool for creating entity-relationship diagrams from plain text markup. Based on erd (uses the same input format and output rendering).

Entities, relationships and attributes are defined in a simple plain text markup format, which is used to generate an entity-relationship diagram in DOT format.

This can then be rendered into e.g. pdf, png, svg, etc. using Graphviz or another similar tool.

Status

Currently under development, general parsing and mostly default output is completed, but not yet feature complete.

Approximate TODO:

  • rendering customisation
  • checks that entities exist when parsing relationships
  • code cleanup/refactoring
  • internal function/parser documentation
  • user guide/overvie(is implemented, but rendering is not)w
  • additional error handling
  • add github actions to run tests
  • add action to build/push docker image to docker hub