Re:Devs need system design tools, not diagramming tools
by nomadicboogie on Wednesday July 17, 2024 @12:24PM
(#40987548)
Lately, I've been developing with Next.js, a React.js framework with full-stack capabilities thanks to React Server Actions and API routes. I decided to create the most useful diagram possible directly from the codebase out of curiousity and because I really like Mermaid.js. I put in plenty of love and know-how to reduce the clutter and focus on the greatest user-affecting insights from a developer standpoint. I ended up producing a diagram generator of frontend components to server actions flow. If you develop with Next.js, you'll love this experience. Based on the article, here's my review of my creation:
+ Real-Time Updates: ApiDiagram generates code directly from the Typescript source code.
+ Elegant User Interface: ApiDiagram utilizes Mermaid.js for the cleanest visual representation.
+ Exact Version Control: ApiDiagram displays the git commit hash of the repository snapshot.
+ Single Source of Truth: ApiDiagram statically analyzes source code using TypeScript.
- Incapable of Managing Cloud Resources: The diagram cannot assist with managing cloud resources.
- Limited Collaboration Capabilities: No way to collaborate yet. Stay tuned :)
I'm also working on a GitHub Action/App that will do an architectural diff on the PR. The core idea is to get insights into architectural changes affecting end-users on every code change. Still in the works, but I would love to hear any thoughts. It's like an instant mini design review on each PR when there is a major change.
+ Real-Time Updates: ApiDiagram generates code directly from the Typescript source code.
+ Elegant User Interface: ApiDiagram utilizes Mermaid.js for the cleanest visual representation.
+ Exact Version Control: ApiDiagram displays the git commit hash of the repository snapshot.
+ Single Source of Truth: ApiDiagram statically analyzes source code using TypeScript.
- Incapable of Managing Cloud Resources: The diagram cannot assist with managing cloud resources.
- Limited Collaboration Capabilities: No way to collaborate yet. Stay tuned :)
I'm also working on a GitHub Action/App that will do an architectural diff on the PR. The core idea is to get insights into architectural changes affecting end-users on every code change. Still in the works, but I would love to hear any thoughts. It's like an instant mini design review on each PR when there is a major change.
https://apidiagram.com