{"id":19685407,"url":"https://github.com/kislerdm/diagramastext","last_synced_at":"2025-07-30T11:39:00.515Z","repository":{"id":65704832,"uuid":"594583980","full_name":"kislerdm/diagramastext","owner":"kislerdm","description":"Application to streamline diagram generation using plain English instructions instead of code","archived":false,"fork":false,"pushed_at":"2024-01-01T17:19:43.000Z","size":4371,"stargazers_count":26,"open_issues_count":13,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-01T10:50:45.182Z","etag":null,"topics":["c4model","chatgpt-api","diagram","go","golang","openai-api","plantuml"],"latest_commit_sha":null,"homepage":"https://diagramastext.dev","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kislerdm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-01-29T01:41:21.000Z","updated_at":"2024-08-30T19:15:48.000Z","dependencies_parsed_at":"2024-06-19T05:18:36.686Z","dependency_job_id":"82708f1a-12ca-4fa0-89bf-7433130dc11f","html_url":"https://github.com/kislerdm/diagramastext","commit_stats":{"total_commits":160,"total_committers":2,"mean_commits":80.0,"dds":"0.018750000000000044","last_synced_commit":"9330f67202f58768bd9ab12a7292503ee490d55b"},"previous_names":["kislerdm/chatgpt-c4"],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/kislerdm/diagramastext","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kislerdm%2Fdiagramastext","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kislerdm%2Fdiagramastext/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kislerdm%2Fdiagramastext/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kislerdm%2Fdiagramastext/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kislerdm","download_url":"https://codeload.github.com/kislerdm/diagramastext/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kislerdm%2Fdiagramastext/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267858876,"owners_count":24155981,"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-07-30T02:00:09.044Z","response_time":70,"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":["c4model","chatgpt-api","diagram","go","golang","openai-api","plantuml"],"created_at":"2024-11-11T18:21:46.393Z","updated_at":"2025-07-30T11:39:00.484Z","avatar_url":"https://github.com/kislerdm.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Diagram As Text\n\nThe tool to generate diagram based on textual description. Although it takes quite some effort to make a diagram, LLM is\nhere for the rescue! 🤖🦾\n\n\u003cvideo src=\"https://user-images.githubusercontent.com/13434797/218483498-57d671ad-6ad0-40af-b107-7d4cb87cc673.mp4\" controls=\"controls\" style=\"max-width: 720px;\"\u003e\u003c/video\u003e\n\n🚀🚀🚀 _Mission_: to enable anyone to explain complex system, or process in a simple way.\n\n🚀🚀 _Objective_: to streamline knowledge sharing through diagrams.\n\n🚀 _MVP_: plain english to [C4 container](http://c4model.com/) diagrams.\n\n🔔 **Wanted**: founding contributors 🔔\n\nThe project is purely community driven - we need your support:\n\n- Please give the project a _star_.\n- Join us as _contributor_: we need software engineers, data scientists, analysts, designers.\n\nIf you are excited about the project, feel comfortable with our [ways of work](#ways-of-work), and want to contribute,\nplease [get in touch](#contacts) for further details.\n\nThank you! 🙏\n\n## Contacts\n\n- Submit\n  your [request](https://github.com/kislerdm/diagramastext/issues/new?assignee=kislerdm\u0026labels=feedback\u0026title=PLEASE%20DEFINE%20YOUR%20REQUEST\u0026body=%23%23%20What%0APlease%20describe%20your%20proposal.%0A%0A%23%23%20Why%0APlease%20clarify%20the%20context.%0A%0A%23%23%20How%0A%0A(optional)%20Please%20sketch%20execution%20paths.)\n- Join us on [Slack](https://join.slack.com/t/diagramastextdev/shared_invite/zt-1onedpbsz-ECNIfwjIj02xzBjWNGOllg)\n- Write us: \u003ca href=\"mailto:hi@diagramastext.com\"\u003ehi@diagramastext.com\u003c/a\u003e\n- Get in touch on [LinkedIn](https://www.linkedin.com/in/dkisler/)\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eOutlook\u003c/strong\u003e\u003c/summary\u003e\n\n* [Ways of work](#ways-of-work)\n    + [Manifesto](#manifesto)\n    + [Process](#process)\n    + [Bets/Panning/Commitment](#betspanningcommitment)\n* [Tech details](#tech-details)\n    + [Architecture](#architecture)\n    + [Local setup](#local-setup)\n* [License](#license)\n    + [Codebase](#codebase)\n    + [Images and diagrams](#images-and-diagrams)\n\n\u003c/details\u003e\n\n## Ways of work\n\n### Manifesto\n\n- We are driven by the mission\n- We respect one another and the community\n- We deliver in lean iterations\n- We work async with pairing programming sessions\n- We share the work openly, see the [license details](#license)\n\n### Process\n\n- We follow [TDD](https://www.guru99.com/test-driven-development.html)\n- We follow [RDD](https://tom.preston-werner.com/2010/08/23/readme-driven-development.html)\n- We maintain flat modules structure whether possible\n- We embrace clean architecture inspired by Alistair\n  Cockburn's [port-adapter approach](https://web.archive.org/web/20180822100852/http://alistair.cockburn.us/Hexagonal+architecture)\n  and Martin Fowler's [inversion of control](https://martinfowler.com/bliki/InversionOfControl.html), see a great\n  write-up [here](https://jmgarridopaz.github.io/content/hexagonalarchitecture.html#tc2-3) on the subjects matter\n- We aim for simplicity with the least external dependencies\n- We follow conventional _comments_ [guideline](https://conventionalcomments.org/) for code reviews\n- We follow conventional _commits_ [guideline](https://www.conventionalcommits.org/en/v1.0.0/):\n    - `feat`: for features\n    - `fix`: for defect fix\n    - `chore`: for infra, ci, or docs adjustments; or refactoring\n- We follow the [monorepo](https://monorepo.tools/) approach\n- We follow [trunk-based development](https://trunkbaseddevelopment.com/) model\n- We follow the release [guideline](https://keepachangelog.com/en/1.0.0/) and [semantic versioning](https://semver.org/)\n\n### Bets/Panning/Commitment\n\n- [Issues Board](https://github.com/users/kislerdm/projects/5/views/)\n\n## Tech details\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eTech stack\u003c/strong\u003e\u003c/summary\u003e\n\n- Languages:\n    - Go 1.19\n    - TypeScript, ES2020:\n      - [vite](https://vitejs.dev)\n      - [vitest](https://vitest.dev/)\n    - Python 3.9\n- Markup:\n    - Markdown\n    - HTML5\n    - CSS3\n- CI:\n    - GitHub Actions\n- Infra:\n    - GCP\n        - IAM\n        - SecretsManager\n        - CloudRun\n        - IdentityPlatform\n    - AWS (infra deprecated as of 2023-03)\n    - GitHub Pages\n    - [Neon](https://neon.tech/)\n    - Cloudflare\n    - namecheap\n    - godaddy\n- Tools:\n    - gnuMake\n    - Docker\n    - terraform\n- Logic:\n    - PlantUML\n    - OpenAI\n\n\u003c/details\u003e\n\n### Architecture\n\n#### C4 Context Level\n\n![architecture-context](architecture_c4_l1.svg)\n\n### Local setup\n\n#### Requirements\n\n- git\n- gnuMake\n- docker ~\u003e 20.10\n\n#### Steps\n\nFollow the steps to provision local development environment.\n\n1. Clone the repo\n\n```commandline\ngit clone git@github.com:kislerdm/diagramastext.git\n```\n\n2. Export OpenAI access [token](https://platform.openai.com/docs/api-reference/authentication) as the environment\n   variable `OPENAI_API_KEY`:\n\n```commandline\nexport OPENAI_API_KEY=##TOKEN##\n```\n\n3. Run to provision the local environment:\n\n```commandline\nmake localenv\n```\n\n**Note**:\n- The webclient will be available on http://localhost:9001\n- The database webclient will be available on http://localhost:9081\n\n4. Run to clean the local environment:\n\n```commandline\nmake localenv-teardown\n```\n\n## License\n\n### Codebase\n\nThe codebase is distributed under the [Apache 2.0 licence](LICENSE).\n\n### Images and diagrams\n\n\u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc-sa/4.0/\"\u003e\u003cimg alt=\"Creative Commons Licence\" style=\"border-width:0\" src=\"https://i.creativecommons.org/l/by-nc-sa/4.0/80x15.png\" /\u003e\u003c/a\u003e\u003cbr /\u003e\nThis work\nby \u003ca xmlns:cc=\"http://creativecommons.org/ns#\" href=\"diagramastext.dev\" property=\"cc:attributionName\" rel=\"cc:attributionURL\"\u003e\ndiagramastext.dev\u003c/a\u003e is licensed under a \u003ca rel=\"license\" href=\"http://creativecommons.org/licenses/by-nc-sa/4.0/\"\u003e\nCreative Commons Attribution-NonCommercial-ShareAlike 4.0 International License\u003c/a\u003e.\nBased on a work at [https://github.com/kislerdm/diagramastext](https://github.com/kislerdm/diagramastext).\nPermissions beyond the scope of this license may be available\nat \u003ca xmlns:cc=\"http://creativecommons.org/ns#\" href=\"diagramastext.dev\" rel=\"cc:morePermissions\"\u003ediagramastext.dev\u003c/a\u003e. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkislerdm%2Fdiagramastext","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkislerdm%2Fdiagramastext","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkislerdm%2Fdiagramastext/lists"}