{"id":21696424,"url":"https://github.com/madetech/structurizr-template","last_synced_at":"2025-08-10T22:06:11.168Z","repository":{"id":149371660,"uuid":"617568305","full_name":"madetech/structurizr-template","owner":"madetech","description":"Static site generator for architecture models created with Structurizr DSL","archived":false,"fork":false,"pushed_at":"2024-07-12T09:41:43.000Z","size":2642,"stargazers_count":9,"open_issues_count":0,"forks_count":2,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-06T07:06:47.378Z","etag":null,"topics":["architecture-diagrams","c4model","documentation","site-generator","software-architecture","structurizr","structurizr-dsl"],"latest_commit_sha":null,"homepage":"https://madetech.github.io/structurizr-template/","language":"ASL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/madetech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-22T16:52:23.000Z","updated_at":"2024-10-04T06:49:11.000Z","dependencies_parsed_at":null,"dependency_job_id":"b451dde9-6979-46f6-ae2c-a2a8dd3b534c","html_url":"https://github.com/madetech/structurizr-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/madetech/structurizr-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madetech%2Fstructurizr-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madetech%2Fstructurizr-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madetech%2Fstructurizr-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madetech%2Fstructurizr-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/madetech","download_url":"https://codeload.github.com/madetech/structurizr-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madetech%2Fstructurizr-template/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269794097,"owners_count":24476742,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["architecture-diagrams","c4model","documentation","site-generator","software-architecture","structurizr","structurizr-dsl"],"created_at":"2024-11-25T19:19:49.758Z","updated_at":"2025-08-10T22:06:11.124Z","avatar_url":"https://github.com/madetech.png","language":"ASL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Get started quickly - Intro to Structurizr\n\n## Background information\n\n* Why we like to [Visualise Architecture](https://github.com/madetech/architecture-handbook/blob/main/learning_paths/visualising_architecture.md).\n  * C4 Model and Structurizr are one way to achieving this.\n  * See more [tools here](https://madetech.github.io/architecture-handbook/principles/tools.html).\n* Knowledge and understanding of [C4 Model](https://c4model.com/).\n* Watch [Diagrams as Code 2.0](https://www.youtube.com/watch?v=Za1-v4Zkq5E) for an explanation/motivation for why Structurizr.\n* Learning the [Structurizr DSL](https://github.com/structurizr/dsl) is important but not necessary for this demo.\n\n## Visual Studio Code Support\n\nThere are two not an official extensions. I would recommend the simple [Structurizr DSL](https://marketplace.visualstudio.com/items?itemName=ciarant.vscode-structurizr) syntax highlighter.\n\nThe other extensions are complicated and can make external calls to render diagrams.\n\n## Local Interactive Server\n\nClone this Repo to get started and you can use [Structurizr Lite](https://structurizr.com/share/76352/documentation) by:\n\n```\ngit clone git@github.com:madetech/structurizr-template.git\ncd structurizr-template\ndocker pull structurizr/lite\ndocker run -it --rm -p 8080:8080 -v $PWD:/usr/local/structurizr structurizr/lite\n```\n\nOpen your browser and go to `localhost:8080`.\n\nThis will allow you to you to use Structurizr website locally as a playground with the example included.\n\n## The idea of this as a \"template\"\n\nAnother company has created a tool for this use case: [Structurizr Site Generatr](https://github.com/avisi-cloud/structurizr-site-generatr)\n\nThis tool includes:\n* Boilerplate structure for a static website hosting C4 Diagrams\n* Support for any Architecture Decision Records\n* Other documentation defined in the [Structurizr DSL](https://github.com/structurizr/dsl)\n* You can get various exports using this tool (`svg`, `png`, `puml`)\n\n\u003e A static site generator for C4 architecture models created with [Structurizr DSL](https://github.com/structurizr/dsl). See [Background](https://github.com/avisi-cloud/structurizr-site-generatr#background) for the story behind this tool.\n\u003e\n\u003e [Click here to see an example of a generated site](https://avisi-cloud.github.io/structurizr-site-generatr) based on the [Big Bank plc example](https://structurizr.com/dsl?example=big-bank-plc) from https://structurizr.com. This site is generated from the example workspace in this repository.\n\u003e\n\u003e ## Structurizr DSL\n\u003e\n\u003e You can write [Structurizr DSL](https://github.com/structurizr/dsl) and publish it to a site a client or team can browse. It also includes support for other documentation and Architecture Decision Records. It should be a one stop shop for documenting your projects.\n\n### Our Altered Static Hosted Example\n\n[GitHub Pages](https://madetech.github.io/structurizr-template/main/) hosts this repo as an example. It is built and deployed via the [GitHub Action here](https://github.com/madetech/structurizr-template/blob/main/.github/workflows/cd.yml).\n\n**Install**:\n\n```\nbrew tap avisi-cloud/tools\nbrew install structurizr-site-generatr\n```\n\nRun the following for a live updating/development site.\n```\nstructurizr-site-generatr serve -w workspace.dsl -a assets\n```\n\nRun the following for a static site. E.g. GitHub Pages\n```\nstructurizr-site-generatr generate-site -w workspace.dsl -a assets --branches main --default-branch main\n```\n\nNote: Assets can be found in the `assets` folder. They can whatever they need to be, e.g. images.\n\n**Support**\n\nRead [Structurizr Site Generatr](https://github.com/avisi-cloud/structurizr-site-generatr) for problems with the tool.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadetech%2Fstructurizr-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmadetech%2Fstructurizr-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadetech%2Fstructurizr-template/lists"}