foam3
c4-notation
foam3 | c4-notation | |
---|---|---|
4 | 126 | |
39 | 25 | |
- | - | |
9.9 | 10.0 | |
5 days ago | almost 5 years ago | |
HTML | ||
Apache License 2.0 | Apache License 2.0 |
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.
foam3
-
How could the early Unix OS comprise so few lines of code?
Thank you for sharing that video! Your foam project looks fascinating too: https://github.com/kgrgreer/foam3
-
A repository of “BASIC Computer Games” code in modern languages
I wrote a BASIC to JS compiler/transpiler that includes all of the programs from "BASIC Computer Games" as examples.
You can try it out in your browser at: https://codepen.io/kgr/full/yLQyLjR
Just select the game you want to to run from the top-left list box, then press the "Compile" button and you'll see the translated JS source in the right text-area. Then press the "Run" button to run it.
The source code for the compiler is available at: https://github.com/kgrgreer/foam3/tree/429f2fd2b4cef0e37996a...
-
Architecture diagrams should be code
Sort of related but an interesting idea is take it one step further with the Feature Oriented Active Modeler (FOAM) [1,2] paradigm and use code to model your whole system, which generates diagrams model, and runnable code in whatever language needed. The project is still young and it may not be practical today with the available tooling but it seems like a cool idea and project. It is influenced by the unix principle of “coding the perimeter not the area” which is essentially factoring your dev tasks into building NM capabilities, but instead of building NM things individually build N+M tools that can be composed into N*M capabilities [2].
So with FOAM the idea is if we want to maintain a model of our software, and build it as well, what if we can use one composable tool to generate both, rather than model everything and code it separately.
[1] https://github.com/kgrgreer/foam3
[2] https://foam-framework.github.io/foam/
[3] https://m.youtube.com/watch?v=3Ea3pkTCYx4
-
Programming Breakthroughs We Need
https://github.com/kgrgreer/foam3#videos
FOAM is a modelling framework that generates cross-language boilerplate for you, but it takes a much broader view of what constitutes boilerplate than most systems. Typically, it can generate between 95-98% of a working cross-language cross-tier system.
FOAM helps you create features for modelled data. Features include things like a Java/Javascript/Swift classes to hold your modelled data, code to marshall to/from JSON/XML/CSV/etc., various GUI Views, and support for storing your data in various databases or file formats. However, FOAM models are themselves modelled, meaning they're afforded all of the above benefits as well. This lets you apply the MVC technique of having multiple views work against the same underlying data-model concurrently (say a grid and a pie-chart in a spreadsheet), so that you can choose the best view or views for your current need. When treated this way, your code is no longer text (but it can be, if that's one of your views), and you can easily view and store it in many different ways and more easily programmatically manipulate it.
c4-notation
-
Ask HN: Guidelines for making clear architecture diagrams
Second this.
Reference for anyone looking I to it: https://c4model.com/
There is also quite a lot of options for helping create these diagrams. I've found https://structurizr.com/ to be the best of what I've tried so far.
-
Show HN: Flyde – an open-source visual programming language
What you are describing sounds a lot like C4: https://c4model.com/
-
Ask HN: How do you document complex software systems?
The C4 model [0] provides a mostly sensible structure and techniques for representing pure software systems across different abstraction levels.
For systems involving software and hardware, or other complex interfacing (both technology and bureaucracy) this starts to delve into the universe of systems engineering. There's a decent assembly of knowledge on that in the SEBoK [1].
As another commenter has already called out too, one of the most valuable sources of information is also _why_ a system is in its current form and _how_ that's changed over time. ADR's [2] really do a good job at nailing this for just about any scale.
[0]: https://c4model.com
[1]: https://sebokwiki.org
[2]: https://adr.github.io
-
A View on Functional Software Architecture
There a various standards for documenting software architecture, like arc42 or C4. While useful and somewhat well-known (there is certainly a correlation here), here architecture documentation can be further simplified, particularly due to the self-similarity of project and component. Following is a small template, that can also serve as a project's and component's README:
- The C4 model for visualising software architecture
-
Inkscape Cloud Architect
I would suggest that if your architecture diagrams are a bunch of icons provided by AWS/Azure/GCP with lines pointing at each other... you are doing it wrong.
The 'what does this box do for my system' is vastly more important than the 'which in vogue offering from my cloud provider implements it'.
I highly suggest folks take a look at the C4 Model: https://c4model.com/
- What do you wish business folks knew about UML?
-
How to create interactive zoomable software architecture diagrams
We often use abstractions in software engineering to communicate complex architectures and software systems. In this article, we’ll discuss how abstractions are inherently hierarchical and how the C4 model provides a nested structure for defining your software architecture. We’ll then cover how IcePanel allows you to create interactive and zoomable diagrams for your audience to zoom in and out of different levels of technical detail.
-
Architecture diagrams enable better conversations
You probably want https://c4model.com/ which explains what a C4 architecture diagram is. (See the first footnote in the article.)
What are some alternatives?
xv6-public - xv6 OS
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
MyDef - Programming in the next paradigm -- your way
backstage - Backstage is an open platform for building developer portals
TALA - A diagram layout engine designed specifically for software architecture diagrams
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
basic-computer-games - An updated version of the classic "Basic Computer Games" book, with well-written examples in a variety of common MEMORY SAFE, SCRIPTING programming languages. See https://coding-horror.github.io/basic-computer-games/
pumla - pumla - systematic re-use of model elements described with PlantUML
language-server-protocol - Defines a common protocol for language servers.
plantuml - Generate diagrams from textual description