{"id":13499970,"url":"https://github.com/cassiobotaro/modeloC4","last_synced_at":"2025-03-29T05:32:49.955Z","repository":{"id":50379998,"uuid":"429583388","full_name":"cassiobotaro/modeloC4","owner":"cassiobotaro","description":"📏Modelo C4 para documentação de arquiteturas","archived":false,"fork":false,"pushed_at":"2025-03-28T01:54:05.000Z","size":55542,"stargazers_count":110,"open_issues_count":0,"forks_count":25,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-28T02:40:07.072Z","etag":null,"topics":["c4-model","diagram","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"ASL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cassiobotaro.png","metadata":{"files":{"readme":"README.md","changelog":null,"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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-18T21:21:58.000Z","updated_at":"2025-03-28T01:54:09.000Z","dependencies_parsed_at":"2024-01-13T18:34:31.339Z","dependency_job_id":"0a3fed9b-5d0e-4e15-b20f-45c701221d49","html_url":"https://github.com/cassiobotaro/modeloC4","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cassiobotaro%2FmodeloC4","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cassiobotaro%2FmodeloC4/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cassiobotaro%2FmodeloC4/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cassiobotaro%2FmodeloC4/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cassiobotaro","download_url":"https://codeload.github.com/cassiobotaro/modeloC4/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246145012,"owners_count":20730494,"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":["c4-model","diagram","hacktoberfest"],"created_at":"2024-07-31T22:00:48.983Z","updated_at":"2025-03-29T05:32:44.947Z","avatar_url":"https://github.com/cassiobotaro.png","language":"ASL","funding_links":[],"categories":["ASL"],"sub_categories":[],"readme":"# Modelo C4 para documentação de arquiteturas\n\n**Update:** Uma atualização foi feita no repositório e os modelos foram reescritos utilizando a ferramenta [Structurizr Lite](https://structurizr.com/help/lite).\n\nEste repositório contém todos os diagramas contidos na apresentação do modelo C4.\n\n[PlantUML](https://plantuml.com/) foi utilizado em conjunto com [C4-PlantUML](https://github.com/plantuml-stdlib/C4-PlantUML) para gerar os diagramas.\n\n## Gerando os diagramas\n\n### Structurizr lite\n\nEscrevi uma função para facilitar a utilização do comando:\n\n```bash\n# structurizr\nfunction structurizr() {\n    readonly file=${1:?\"The workspace filename must be specified.\"}\n    if [[ \"$file\" == *.* ]]; then\n        echo \"The workspace filename should not contains a file extension.\"\n        return 1\n    fi\n    if [[ !  -f \"./structurizr.properties\" ]]; then\n        echo \"structurizr.autoRefreshInterval=2000\" \u003e structurizr.properties\n    fi\n    docker run --rm -it \\\n        -p 8080:8080 \\\n        -u $(id -u ${USER}):$(id -g ${USER}) \\\n        -v \"$PWD\":/usr/local/structurizr/ \\\n        -e STRUCTURIZR_WORKSPACE_FILENAME=$file \\\n            structurizr/lite\n}\n```\n\nEla será invocada da seguinte maneira:\n\n```bash\nstructurizr nome_do_arquivo_sem_extensão\n```\n\nPara exportar os arquivos em png ou svg, mantenha a instância do structurizr rodando e utilize a seguinte função descrita abaixo.\n\n```sh\nfunction export_c4(){\n    readonly format=${1:?\"The format must be specified.\"}\n    [ ! -f export-diagram.js ] \u0026\u0026 wget https://github.com/cassiobotaro/modeloC4/raw/main/export-diagram.js\n    text=$(docker run -i --init --cap-add=SYS_ADMIN --net=host --name=exporter ghcr.io/puppeteer/puppeteer:latest node -e \"$(cat export-diagrams.js)\"  \"\" \"http://localhost:8080\" \"$format\")\n    files=($(echo \"$text\" | grep -o \"\\S*\\.$format\"))\n    for file in \"${files[@]}\"\n    do\n        docker cp exporter:/home/pptruser/\"$file\" .\n    done\n    docker rm exporter\n}\n```\n\nEla será invocada da seguinte maneira:\n\n```bash\nexport_c4 png\n```\n\n### PlantUML\n\nO [VS Code](https://code.visualstudio.com/) possui um plugin para PlantUML que pode ser encontrado na marketplace: [PlantUML for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml).\n\nCaso queira rodar localmente será necessário instalar o [Graphviz](https://www.graphviz.org/). No sistema operacional Ubuntu o comando é:\n\n    sudo apt-get install graphviz openjdk-17-jre\n\nOs diagramas também podem ser gerados utilizando o servidor remoto: http://www.plantuml.com/plantuml/uml/.\n\nAbra os arquivos de extensão `.puml` ou copie seu conteúdo para o editor ou navegador.\n\nCaso esteja utilizando a versão online, clique no botão `Render` para gerar a imagem.\n\nSe estiver rodando localmente, aperte `ALT + D` para ter uma pré visualização, ou `CTRL + SHIFT + P` e selecione a opção de exportar a imagem ou pré visualização.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcassiobotaro%2FmodeloC4","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcassiobotaro%2FmodeloC4","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcassiobotaro%2FmodeloC4/lists"}