https://github.com/arnauld/sketchit
Hand drawn looking class diagram
https://github.com/arnauld/sketchit
Last synced: 3 days ago
JSON representation
Hand drawn looking class diagram
- Host: GitHub
- URL: https://github.com/arnauld/sketchit
- Owner: Arnauld
- Created: 2012-07-30T21:37:31.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2021-06-07T17:44:50.000Z (about 5 years ago)
- Last Synced: 2025-01-10T18:54:44.722Z (over 1 year ago)
- Language: Java
- Homepage: http://arnauld.github.com/sketchit/
- Size: 397 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.markdown
Awesome Lists containing this project
README
# Getting started
```dot
[note: You can stick notes on diagrams too!{bg:cornsilk}]
[Customer]<>1-orders 0..*>[Order{bg:#87cefa}]
[Order]++*-*>[LineItem]
[Order]-1>[DeliveryMethod{bg:thistle}]
[Order]*-*>[Product{bg:#cd5c5c}]
[Category{bg:moccasin}]<->[Product]
[DeliveryMethod]^[National{bg:coral}]
[DeliveryMethod]^[International{bg:#98fb98}]
```
is transformed into:
# Syntax
Syntax for Class diagram is based on [yUML](http://yuml.me/diagram/class/draw) syntax
Class [Customer]
Directional [Customer]->[Order]
Bidirectional [Customer]<->[Order]
Aggregation [Customer]+-[Order] or [Customer]<>-[Order]
Composition [Customer]++-[Order]
Inheritance [Customer]^[Cool Customer], [Customer]^[Uncool Customer]
Dependencies [Customer]uses-.->[PaymentStrategy]
Cardinality [Customer]<1-1..2>[Address]
Labels [Person]customer-billingAddress[Address]
Notes [Person]-[Address],[Address]-[note: Value Object]
Full Class [Customer|Forename;Surname;Email|Save()]
Splash of Colour [Customer{bg:orange}]<>1->*[Order{bg:green}]
[Foo|valueProp]
[Foo]entityRef->[Bar]
[Foo]entityComp++->ownedBy[Baz]
[Foo]oneToMany->*[FooBar]
[Bar|name]
[FooBar|value]
[FooBar]^[Bar]
[Customer]<>1->*[Order],
[Customer]-[note: Aggregate Root{bg:cornsilk}]
# Libraries & Inspirations
* [yUML](http://yuml.me/)
* [Class diagram](http://yuml.me/diagram/scruffy/class/samples)
* [Graphviz](http://www.graphviz.org/)
* [Arrows](http://www.graphviz.org/doc/info/arrows.html)
* [Shapes](http://www.graphviz.org/doc/info/shapes.html)
* [Colors](http://www.graphviz.org/doc/info/colors.html)
* [Web sequence diagrams](http://www.websequencediagrams.com/)
* [Pic language](http://en.wikipedia.org/wiki/Pic_language)
* http://floppsie.comp.glam.ac.uk/Glamorgan/gaius/web/pic.html
* [pic2plot](http://www.gnu.org/software/plotutils/manual/en/html_node/pic2plot.html#pic2plot)
* [UmlGraph](http://www.umlgraph.org/doc.html)
* [Sequence Diagrams](http://www.umlgraph.org/doc/seq-intro.html)
* [Inkscape](http://inkscape.org/)
* http://wiki.inkscape.org/wiki/index.php/MacOS_X
* SVG
* Drop Shadow: http://xn--dahlstrm-t4a.net/svg/filters/arrow-with-dropshadow-lighter.svg