Skip to content

RVR06/c4-bootcamp

Repository files navigation

BOOTCAMP

We introduced the concept of architecture as code, or a code-first approach. We took the opportunity to leverage the Structurizr tool suite to support the end-user journey. However, most of that journey focused on what you can gain from a model defined as code, without spending too much time on how to author that model. It is now time to address this point.

What will you learn from this course

Leveraging a hypothetical requirement, this bootcamp will guide you through small stages to gradually define and refine a compelling software model. Along the way, you will be exposed to the multiple dimensions a software model should cover. Each stage gives insight into both the corresponding Structurizr syntax and the underlying C4 philosophy.

The course is self-directed learning. You can do it at whatever pace you wish.

How to get started

Here’s how the C4 bootcamp works.

Use GitHub to Make Life Easy

This GitHub repository contains workspaces and other assets you will need to complete the bootcamp.

Thus, if you want to follow the bootcamp we recommend doing the following:

  • Sign up for GitHub, if you haven’t already.
  • Clone this repository to your local machine.
  • As you go through the project, keep a web browser tab open to the c4 bootcamp so you can read all of the instructions clearly and easily.

Bootcamp structure

C4 bootcamp consists of 17 stages:











And a bunch of bonus stages:





Stage Layout

Each stage contains the following structure:

╠══ Stage xx
║   ╠══ README.md       // step-by-step recipe
║   ╠══ theme*.dslf      // extra theme(s) definition (optional)
║   ╚══ workspace.dsl   // completed lesson workspace

Each C4 bootcamp stage contains a README which explains the following:

  1. The Structurizr concepts (eg ) and tools you will be applying in the lesson, along with links to any relevant documentation or examples.
  2. Step-by-step instructions (✏️) on how to modify the workspace to match the expected one at the end of each lesson. Feel free to jump from ✏️ to ✏️, if you want to quickly unfold the stage.
  3. If you get stuck following the step-by-step instructions, each lesson contains checkpoints (📙) and a completed workspace.dsl (📘) file that shows the expected output. You can compare this against your own code and see what you need to do differently.

Each stage enriches the previous one, allowing you to tailor a software model from scratch to completion. If you are interested in an intermediate stage and don't want to go through the full journey first, just take the previous state (*.dsl files) as your starting point. For example, if you would like to exercise stage 07, copy and paste the *.dsl files from stage 06, then continue from there.

When you're doing the lessons...

A few things to bear in mind when you are following the step-by-step instructions:

  1. Don't just copy and paste the code shown in the lesson's README. You'll retain and learn all of the built-in Structurizr functions if you type out the code as it's shown.
  2. You might be required to fill in some blanks during individual lessons. Part of helping you learn Structurizr involves leaving some parts of the exercise up to you - if you ever feel lost, always check the contents of the workspace.dsl for that lesson.
  3. Don't be afraid to ask questions.

Docs

We will provide explanations of all key concepts throughout each lesson, but of course, you should bookmark (and feel free to use!) the C4 documentation

Tools / prerequisites

This course expects the following:

  • A GitHub account and basic knowledge of Git
  • An up-to-date installation of VS Code editor
  • An up-to-date Cornifer extension
  • An up-and-running Docker daemon

See here for details.

Time to engage

Here we go

About

Hands on labs and content to learn and teach how to craft compelling software model leveraging C4 model, Structurizr & Cornifer.

Topics

Resources

License

Contributing

Stars

4 stars

Watchers

1 watching

Forks

Contributors