shotglass
C4-PlantUML
| shotglass | C4-PlantUML | |
|---|---|---|
| 2 | 24 | |
| 20 | 6,072 | |
| - | 1.7% | |
| 8.6 | 6.9 | |
| about 1 month ago | 6 days ago | |
| Jupyter Notebook | PlantUML | |
| MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
shotglass
-
Ask HN: Visualizing software designs, especially of large systems (if at all)?
Very interesting! I'm convinced humans looking at code plots can see things that computers can't. An extension of your idea is to show how code changes over time. Sections that don't change much = "backbone" of system, probably bug-free. New code, or code that changes a lot = "sketchy", might have bugs. Alternatively, show code colored by "quality" i.e. complexity.
Here's my take: https://github.com/johntellsall/shotglass#demo-flask-a-small...
-
Need to write README but don't know what to say? 7 diagram generators
This is close to my heart :) I've been toying with a codebase visualizer, "Shotglass". It's unique that it shows a pixel _for every single line of code_, thus showing the overall structure. Functions can be individually colored, e.g. to show code complexity.
Code + screenshots: https://github.com/johntellsall/shotglass#demo-django-a-bit-...
C4-PlantUML
-
Ask HN: Guidelines for making clear architecture diagrams
Third this. Don't look any further, just do it!
Also, PlantUML + C4 is like peanut butter & jelly:
https://github.com/plantuml-stdlib/C4-PlantUML
I'll gladly give up control of layout, and accept some ugliness, to never again have to worry about dragging boxes and arrows to be pixel-aligned, and then do it all over again when I add another box...
It looks like Mermaid has C4 support too:
https://mermaid.js.org/syntax/c4.html
-
Documentation as Code for Cloud - C4 Model & Structurizr
C4-PlantUML: Export your model as C4-PlantUML diagrams.
-
Which tools do you use to create diagrams?
PlantUML + C4 plugin;
-
Add quick sketches in emacs org mode
Yes. I use this all the time for software diagramming. With c4 model (https://github.com/plantuml-stdlib/C4-PlantUML) and AWS icons (https://github.com/awslabs/aws-icons-for-plantuml)
-
Architecture diagrams should be code
The C4 model (https://c4model.com/) is great for architecture diagrams. You can use different tools to generate them. Here are the ones I've been using:
- https://github.com/plantuml-stdlib/C4-PlantUML
- D2 language, open source alternative to PlantUML
- Keep your diagrams updated with continuous delivery
- What FOSS programs would you recommend for creating concept maps on Linux?
-
C4 model for system architecture design
3️⃣ Text-based diagramming- C4-PlantUML
-
Ask HN: Confluence Alternative(s) Supporting Markdown?
> onboarding docs
yes, they're don't changing frequently
> system design docs
yes - see C4-PlantUML[1]
> meeting notes
no, unless they're directly code related like ADRs [2,3].
Although one can abuse Github Issues + comments for this, in my opinion it's better to use modern SaaS tools for this, i.e. Loom, Descript, Linear.app, etc. - you can automate this process, e.g. transcribe the meeting's recording and add the issue/repo using Github Actions.
--
[1] https://github.com/plantuml-stdlib/C4-PlantUML
[2] https://adr.github.io/
[3] https://docs.aws.amazon.com/prescriptive-guidance/latest/arc...
What are some alternatives?
spekt8 - Visualize your Kubernetes cluster in real time
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
saddle-data-graph - where does it come from, where does it go?
d2 - D2 is a modern diagram scripting language that turns text to diagrams.
plurid - Explore Information as a 3D Structure
aws-icons-for-plantuml - PlantUML sprites, macros, and other includes for Amazon Web Services services and resources
Pythonocc-nodes-for-Ryven - Pythonocc nodes for Ryven
Azure-PlantUML - PlantUML sprites, macros, and other includes for Azure services
c4-notation - Technical resources for using the C4 model for visualizing software architecture.
backstage - Backstage is an open platform for building developer portals
Sourcetrail - Sourcetrail - free and open-source interactive source explorer
dsl - Structurizr DSL