spree-guides icon indicating copy to clipboard operation
spree-guides copied to clipboard

Spree Class Diagram

Open krigar opened this issue 10 years ago • 4 comments

While in the process of customizing Spree to handle multiple shipping addresses for one Order, I saw it fit to create a class diagram. There didn't seem to be one in the docs and none of the automated processes really worked due to the fragmented structure of Spree, thus it's very much hand made and a work in progress.

I also suspect that something like this already exists among the core contributors? It would be great to have it in the official docs; if it doesn't exists I'd be more than happy to finish my diagram and share it here:

spree uml

krigar avatar Jul 25 '14 08:07 krigar

It'd also be nice if there was a database ER diagram.

jhirbour avatar Jul 25 '14 13:07 jhirbour

I think a database ERD would fall out of relevance fairly quickly given how quickly Spree changes.

How is this maintained? Is it easy to add new tables/fields to it?

radar avatar Jul 28 '14 04:07 radar

I'm using a tool called Lucidchart. Their drawing tool is decent and it makes it easy to share and collaborate; unfortunately you'll have to pay for it once a document becomes as complex as this class diagram.

Here's a link to an open version which anyone can edit: http://www.lucidchart.com/invitations/accept/718d5a33-d5aa-48a9-ad24-02cbb9d5ece7

If anyone knows of any better collaborative diagram tools, let me know and I'll see if I can import it.

krigar avatar Jul 28 '14 11:07 krigar

@krigar would love an updated version, keep working on it!

lukeholder avatar Mar 08 '17 10:03 lukeholder