Comments (25)
Group entities
Great!!! But in order to have groups shown, it must be informed as metadata:
module.exports =
herbarium.entities
.add(List, 'List')
.metadata({ group: 'Core Entities' })
.entity
from herbsshelf.
becase the #41 PR already fix this current issue
well, not really. the initial idea was to have this diagrams inside Shelf UI with diagrams auto generated by Herbs metadata. The PR above only allows to Mermaid diagrams to be part of the README file, created manually (which is completely fine).
from herbsshelf.
@maikmb ideally we could have a more in-depth discussion on how to document the entities, but thinking about it, I believe your suggestion would work well for a first version
from herbsshelf.
I have an example of a complex entities class diagram #38 (comment)
We could use groups metadata to entities like we have in use cases. This way we could create sub-views to view entities so we don´t have to show the whole thing... yes, I know, it is another issue, but just to document it
from herbsshelf.
Just to give some example about what we can explore, I would like to share this link that Dalsoft shared with me
we have many diagrams opportunity to explore with this feature
from herbsshelf.
why did you reopen it?
If you reopen it becase we need to improve the current implementation, you could to open another issue, becase the #41 PR already fix this current issue
from herbsshelf.
@dalssoft is right. I reopened it because is not totally closed yet.
from herbsshelf.
Hi guys! I will work on this issue!
from herbsshelf.
Hey guys. Any suggestion? I'm working on this feature and just missing details to complete it.
from herbsshelf.
Thanks @dalssoft! We will implement the first version and improve it later.
from herbsshelf.
Maik, I believe the diagram connection (1 ... N ) in the image is missing, right?
Like this:
from herbsshelf.
Hi @jhomarolo!
I was implementing this feature.
from herbsshelf.
Looks great. We should test it in a big project and see how it behaves.
from herbsshelf.
@maikvortx I think is missing the pointer showing the relation 1 ... N
Inside the diagram should be TodoList "1" --> "*" Item
But, anyhow, looks amazing! This is a huge feature
from herbsshelf.
Related: #24
from herbsshelf.
Hi everyone!
@jhomarolo The relationship is created automatically by herbsshelf.
from herbsshelf.
Hey guys, I have implemented the new version of the herbs shelf in internal project and I have an example of a complex entities class diagram:
from herbsshelf.
@maikvortx, It's becoming excellent! I have only two considerations:
1 - About the ordering of the diagram. Is there any way to sort the diagram automatically? It seemed to me that the diagram gets a little confusing in a big system
2 - I believe that mine needs to include use cases and entities. That is, create a folder called use cases and leave them there. From the way you sent the print, it implies that the entities link is also a use case
Does it make sense to you? I think we're almost there on this PR!
from herbsshelf.
@maikmb amazing work! this is going to be a killer feature!
I agree with @jhomarolo on (1): i think we should find a way to implement a diagram reorder. ideally having a button where the user can choose which reorder they want. regarding (2) (to include use cases and entities), i think it is a improvement we can discuss, but for now I would leave without UCs.
from herbsshelf.
Hey guys! I agree with you.
(1) What do think about implementing diagram reorder in another PR? I will study Mermaid to implement this feature. In a big project, the class diagram gets a little confusing.
(2) About usecases, I will implement this in another PR for this issue #37
from herbsshelf.
I will study Mermaid to implement this feature. In a big project, the class diagram gets a little confusing.
"de bate pronto", is there a any indication of Mermaid having this feature? It doesn't seem like it mermaid-js/mermaid#806
from herbsshelf.
@maikmb It seems we have many ideas of improvements here. But what is missing to accept this PR? #47
from herbsshelf.
I have an example of a complex entities class diagram #38 (comment)
We could use groups metadata to entities as we have in use cases. This way we could create sub-views to view entities so we don´t have to show the whole thing... yes, I know, it is another issue, but just to document it
It's a good idea @dalssoft. I can implement it in another PR.
from herbsshelf.
@maikmb It seems we have many ideas for improvements here. But what is missing to accept this PR? #47
@dalssoft I think this PR can be approved. The improvements discussed here will be implemented separated.
from herbsshelf.
Hey guys! What you think about this layout:
- Group entities
- Group Usecases
- Include usecase workflow at the bottom of the details
from herbsshelf.
Related Issues (20)
- Generate documents offline HOT 3
- Array description for Request and Response HOT 2
- Better IF representation HOT 1
- Unnecessary scroll bars when mouse over HOT 1
- Link to Herbs project HOT 1
- Disable shelf in production or protect with password HOT 2
- Icons now showing up HOT 3
- A place to find all my Shelf's HOT 2
- Icons in dark mode HOT 2
- Doc Entities HOT 1
- Herbarium - Use it for discovery HOT 4
- Use case visualization with Mermaid.js HOT 17
- Error when using single quotes on README HOT 3
- Shelf UI improvements HOT 5
- CSS Zoom needs to be improved in entities HOT 5
- Better entity documentation
- Shelf executable.
- Field is displayed as undefined when it is string array HOT 1
- Usecase response is weird when usecase has no request HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from herbsshelf.