{"id":13550927,"url":"https://github.com/DavidGamba/go-wardley","last_synced_at":"2025-04-03T01:30:38.535Z","repository":{"id":57538158,"uuid":"221621458","full_name":"DavidGamba/go-wardley","owner":"DavidGamba","description":"Go Wardley maps generator","archived":false,"fork":false,"pushed_at":"2023-03-29T15:29:31.000Z","size":51,"stargazers_count":30,"open_issues_count":1,"forks_count":6,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-05-02T01:15:27.882Z","etag":null,"topics":["golang","wardley","wardley-maps","wardleymaps"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DavidGamba.png","metadata":{"files":{"readme":"README.adoc","changelog":"changelog.adoc","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-11-14T05:47:23.000Z","updated_at":"2023-03-24T12:47:01.000Z","dependencies_parsed_at":"2024-01-03T05:00:27.549Z","dependency_job_id":null,"html_url":"https://github.com/DavidGamba/go-wardley","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidGamba%2Fgo-wardley","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidGamba%2Fgo-wardley/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidGamba%2Fgo-wardley/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DavidGamba%2Fgo-wardley/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DavidGamba","download_url":"https://codeload.github.com/DavidGamba/go-wardley/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246921921,"owners_count":20855339,"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","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":["golang","wardley","wardley-maps","wardleymaps"],"created_at":"2024-08-01T12:01:39.766Z","updated_at":"2025-04-03T01:30:38.192Z","avatar_url":"https://github.com/DavidGamba.png","language":"Go","funding_links":[],"categories":["Go","Apps","golang"],"sub_categories":["Mapping"],"readme":"= Go-Wardley - Wardley maps generator\nDavid Gamba, https://github.com/DavidGamba\n:idprefix:\n:toc: macro\n\nWardley Maps Generator written in Golang.\nThe generator takes an HCL based map description and generates a map in SVG format.\nIf viewed on a browser, the SVG will have hover over functionality to get additional details on node descriptions.\n\ntoc::[]\n\n== Usage\n\n----\n$ ./go-wardley -f examples/map.hcl\nUpdated file: examples/map.svg\n\n$ ./go-wardley -f examples/map.hcl -o examples/map.svg\nUpdated file: examples/map.svg\n\n# Watch for file changes and update the file automatically.\n$ ./go-wardley -f examples/map.hcl --watch\nStarting watcher on: examples\nUpdated file: examples/map.svg\nUpdated file: examples/map.svg\n\n# Serve the file on a webserver in localhost:8080 by default\n# Update the drawing by refreshing the page.\n$ ./go-wardley -f examples/map.hcl --serve\nServing content on: http://localhost:8080\n$ ./go-wardley -f examples/map.hcl --serve 6060\nServing content on: http://localhost:6060\n----\n\nimage::./examples/map.svg[]\n\n== Element types\n\n=== Size\n\n----\nsize {\n\twidth     = 1280\n\theight    = 768\n\tmargin    = 40\n\tfont_size = 9\n}\n----\n\n=== Node\n\n----\nnode user {\n\tlabel       = \"User\"        # Required\n\tvisibility  = 1             # Required\n\tevolution   = \"custom\"      # Required\n\tx           = 1             # Required\n\tdescription = \"Description\"\n\tfill        = \"black\"\n\tcolor       = \"black\"\n}\n----\n\n`evolution`:: `genesis`, `custom`, `product` or `commodity`.\n\n=== Connector\n\n----\nconnector {\n\tfrom  = \"user\"        # Required\n\tto    = \"vcs\"         # Required\n\tlabel = \"Description\"\n\tcolor = \"black\"\n\ttype  = \"normal\"\n}\n----\n\n`type`:: `normal`, `bold`, `change` or `change-inertia`.\n\n== Example input\n\nA more extensive example can be found in link:./examples/map.hcl[].\n\n[source, hcl]\n----\n# Anchor\nnode user {\n\tlabel       = \"User\"\n\tvisibility  = 1\n\tevolution   = \"custom\"\n\tx           = 1\n\tdescription = \"User Description\"\n\tfill        = \"black\"\n}\n\nnode vcs {\n\tlabel       = \"On Prem VCS\"\n\tvisibility  = node.user.visibility + 1\n\tevolution   = \"product\"\n\tx           = 1\n\tdescription = \"On prem VCS\"\n\tfill        = \"black\"\n}\n\nnode code_commit {\n\tlabel       = \"Code Commit Mirror\"\n\tvisibility  = node.vcs.visibility\n\tevolution   = \"commodity\"\n\tx           = 1\n\tdescription = \"Allows Code Pipeline to access the code.\"\n\tcolor       = \"red\"\n}\n\nconnector {\n\tfrom = \"user\"\n\tto   = \"vcs\"\n}\n\nconnector {\n\tfrom = \"vcs\"\n\tto   = \"code_commit\"\n\tcolor = \"red\"\n\ttype = \"change-inertia\"\n}\n----\n\n== Roadmap\n\n* Make the node label optional, read the node ID if not present and title case it (configurable?).\n\n* Add an optional leyend box indicating the types of elements used in the map.\n\n* Better looks overall. Cleaner code.\n\n* Allow specifying node, connector and grid font sizes independently.\n\n* Arch type connector.\n\n== License\n\nThis file is part of go-wardley.\n\nCopyright (C) 2019-2020  David Gamba Rios\n\nThis Source Code Form is subject to the terms of the Mozilla Public\nLicense, v. 2.0. If a copy of the MPL was not distributed with this\nfile, You can obtain one at http://mozilla.org/MPL/2.0/.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDavidGamba%2Fgo-wardley","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDavidGamba%2Fgo-wardley","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDavidGamba%2Fgo-wardley/lists"}