gopher-holes-unlimited
c4-notation
gopher-holes-unlimited | c4-notation | |
---|---|---|
16 | 126 | |
60 | 25 | |
- | - | |
0.0 | 10.0 | |
over 1 year ago | almost 5 years ago | |
JavaScript | ||
MIT License | 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.
gopher-holes-unlimited
-
A Beginner's Guide to the Serverless Application Model (SAM)
When you define the backing resources and request schemas in your spec file, SAM will automatically create a huge amount of supporting resources:
-
Are We Making Lambda Too Hard?
If we take my reference application Gopher Holes Unlimited as an example, we see that I have a function that updates an existing gopher and another function that links gophers to gopher holes.
-
I Have Good News And Bad News About Your Cloud Metrics
Gopher Holes Unlimited
-
Serverless API Essentials: PUT vs PATCH
Any operation that you need to be idempotent and require the full resource data to be provided should be backed by a PUT operation. For example, if we take the update gopher hole endpoint from my reference project Gopher Holes Unlimited, you can see that we overwrite the entire gopher hole resource.
-
Infrastructure From Code - My First Impression
The real key to the success I've had doing this is that I can quickly find my resources from a known entry point, like an API endpoint. I can look at my spec, see that it ties to a specific Lambda function, and go straight there.
-
Best Practices for Building Serverless Microservices
With serverless microservices, structure your root-level folders by resource type. Take the Gopher Holes Unlimited reference architecture project as an example.
-
Introducing A New Cross-Cutting Architecture Diagram: The Critical Path
When talking about data flows, I mean the path through your system a business process follows. If we take an example from Gopher Holes Unlimited, we can see what happens when a new gopher is added to the system.
-
Build Better Serverless APIs By Going Storage First
I'm not a fan of providing theory without practice. So I have revamped my Gopher Holes Unlimited application to show the specifics of how to setup and process jobs.
-
How (and Why) You Need To Start Generating Your Serverless Infrastructure Diagrams
# My Example Microservice ## Description This is an example README for **Gopher Holes Unlimited** - a fake business but real API that tracks two things: 1. Gophers 2. Holes ## Infrastructure ![Infrastructure Diagram](/diagrams/diagram.png) *Resources currently deployed in Production. This diagram was automatically generated in the CI pipeline* ## Source If you want to check out the source, please visit our [GitHub page](https://github.com/allenheltondev/gopher-holes-unlimited)
-
Solutions Architect Tips - The 5 Types of Architecture Diagrams
We will take an example from my fake business but real API, Gopher Holes Unlimited, where we add a new gopher into the system to be tracked.
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?
postman-contract-test-generator - Postman collection and environment that will take an Open API Spec, validate component adherence, generate contract tests, and execute them.
excalidraw - Virtual whiteboard for sketching hand-drawn like diagrams
serverless-websockets - Get started with websockets with this serverless solution
backstage - Backstage is an open platform for building developer portals
serverless-graphql - Serverless GraphQL Examples for AWS AppSync and Apollo
C4-PlantUML - C4-PlantUML combines the benefits of PlantUML and the C4 model for providing a simple way of describing and communicate software architectures
aws-cdk - The AWS Cloud Development Kit is a framework for defining cloud infrastructure in code
mermaid - Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
draw.io - draw.io is a JavaScript, client-side editor for general diagramming.
pumla - pumla - systematic re-use of model elements described with PlantUML
terraform - Terraform enables you to safely and predictably create, change, and improve infrastructure. It is a source-available tool that codifies APIs into declarative configuration files that can be shared amongst team members, treated as code, edited, reviewed, and versioned.
plantuml - Generate diagrams from textual description