{"id":18412519,"url":"https://github.com/boyney123/cloudcatalog","last_synced_at":"2025-04-07T11:32:03.959Z","repository":{"id":215639860,"uuid":"738989969","full_name":"boyney123/cloudcatalog","owner":"boyney123","description":"Discover, Explore and Document your AWS architectures powered by Markdown.","archived":false,"fork":false,"pushed_at":"2024-02-04T16:33:54.000Z","size":6851,"stargazers_count":109,"open_issues_count":1,"forks_count":8,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-22T17:11:26.267Z","etag":null,"topics":["architecture","aws","documentation","documentation-tool","serverless"],"latest_commit_sha":null,"homepage":"https://cloudcatalog.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boyney123.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-01-04T14:16:29.000Z","updated_at":"2025-01-05T13:58:31.000Z","dependencies_parsed_at":"2024-01-19T09:29:25.187Z","dependency_job_id":"1759a1b7-1c6f-4b79-a101-8c5895e4257a","html_url":"https://github.com/boyney123/cloudcatalog","commit_stats":null,"previous_names":["boyney123/cloudcatalog"],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boyney123%2Fcloudcatalog","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boyney123%2Fcloudcatalog/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boyney123%2Fcloudcatalog/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boyney123%2Fcloudcatalog/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boyney123","download_url":"https://codeload.github.com/boyney123/cloudcatalog/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247644371,"owners_count":20972274,"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":["architecture","aws","documentation","documentation-tool","serverless"],"created_at":"2024-11-06T03:42:28.322Z","updated_at":"2025-04-07T11:31:58.948Z","avatar_url":"https://github.com/boyney123.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n\n\u003ch1\u003e📖 CloudCatalog\u003c/h1\u003e\n\u003cp\u003eDiscover, Explore and Document your AWS Architectures.\u003c/p\u003e\n\n\u003c!-- [![MIT License][license-badge]][license] --\u003e\n\u003c!-- [![PRs Welcome][prs-badge]][prs] --\u003e\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n[![Watch on GitHub][github-watch-badge]][github-watch]\n[![Star on GitHub][github-star-badge]][github-star]\n\n\u003chr /\u003e\n\n\u003cimg alt=\"header\" src=\"https://www.cloudcatalog.dev/img/screenshot.png\" /\u003e\n\n  \u003ch3\u003eFeatures: Website generator for AWS Architectures, Markdown driven, Document Resources/Services/Owners, and more...\u003c/h3\u003e\n\n[Read the Docs](https://cloudcatalog.dev/) | [Edit the Docs](https://github.com/boyney123/cloudcatalog) | [View Demo](https://app.cloudcatalog.dev/)\n\n\u003c/div\u003e\n\n\u003chr/\u003e\n\n# Core Features\n\n- 🔎 Import Resources\n- 📃 Document Resources, Services, Teams\n- 📊 Visualise Resources\n- 🗄️ Powered by markdown\n- 📑 Keep up to date\n- ⭐ And much more...\n\n**All powered by markdown**\n\n# The problem\n\nIn 2022 we created [EventCatalog](https://eventcatalog.dev), a tool that allows you to document your event-driven architecture. CloudCatalog is a fork of [EventCatalog](https://eventcatalog.dev), that allows you to document your AWS architecture.\n\nWhen documenting architectures we tend to lean to architecture diagrams, OpenAPI Specifications or custom wikis that help us document our systems but can we do more?\n\nWhat if we could:\n\n- Document resources in seconds\n- Use Markdown to document our architecture.\n- Enrich our documentation with custom components\n- Group AWS resources in services and assign owners (users or teams) to them\n- Help developers understand our architecture with simple diagrams and markdown content, and more...\n\nSay hello to CloudCatalog.\n\n**CloudCatalog is designed to help people understand, document and discover their AWS Architectures.**\n\nWe can do so much more to document our Architectures.\n\nCloudCatalog is Open Source and hopefully it can add value to your teams.\n\n# This solution\n\n\u003c!-- \u003cimg alt=\"header\" src=\"./images/architecture-2.png\" /\u003e --\u003e\n\nThink of CloudCatalog as a website generator that allows you to document your architectures with markdown files.\n\nMarkdown files are quite a popular tool to help us document content, so why not use markdown files to document our resources and services?\n\nYou can read more on [how it works on the website](https://cloudcatalog.dev)\n\n# Getting Started\n\nYou should be able to get setup within minutes if you head over to our documentation to get started 👇\n\n➡️ [Get Started](https://cloudcatalog.dev/docs/overview/getting-started/installation)\n\nOr run this command to build a new catalog\n\n```\nnpx @cloudcatalog/create-catalog@latest my-cloudcatalog\n```\n\n# Demo\n\nHere is an example of a CloudCatalog hosting a few teams, users and Lambda resources.\n\n[app.cloudcatalog.dev](https://app.cloudcatalog.dev/)\n\nYou can see the markdown files that generated the website in the GitHub repo under [examples](/examples).\n\n# Contributing\n\nIf you have any questions, features or issues please raise any issue or pull requests you like. We will try my best to get back to you.\n\n[license-badge]: https://img.shields.io/github/license/boyney123/cloudcatalog.svg?color=yellow\n[license]: https://github.com/boyney123/cloudcatalog/blob/master/LICENSE\n[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square\n[prs]: http://makeapullrequest.com\n[github-watch-badge]: https://img.shields.io/github/watchers/boyney123/cloudcatalog.svg?style=social\n[github-watch]: https://github.com/boyney123/cloudcatalog/watchers\n[github-star-badge]: https://img.shields.io/github/stars/boyney123/cloudcatalog.svg?style=social\n[github-star]: https://github.com/boyney123/cloudcatalog/stargazers\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n\n# License\n\nMIT.\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://boyney.io/\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/3268013?v=4?s=100\" width=\"100px;\" alt=\"David Boyne\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eDavid Boyne\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/boyney123/cloudcatalog/commits?author=boyney123\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"https://github.com/boyney123/cloudcatalog/commits?author=boyney123\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"#content-boyney123\" title=\"Content\"\u003e🖋\u003c/a\u003e \u003ca href=\"#data-boyney123\" title=\"Data\"\u003e🔣\u003c/a\u003e \u003ca href=\"#design-boyney123\" title=\"Design\"\u003e🎨\u003c/a\u003e \u003ca href=\"#ideas-boyney123\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e \u003ca href=\"#maintenance-boyney123\" title=\"Maintenance\"\u003e🚧\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://sean.lane.sh\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/5761232?v=4?s=100\" width=\"100px;\" alt=\"Sean Lane\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eSean Lane\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/boyney123/cloudcatalog/issues?q=author%3Aseanlane\" title=\"Bug reports\"\u003e🐛\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"https://speedrun.cc\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/97474956?v=4?s=100\" width=\"100px;\" alt=\"perpil\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eperpil\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/boyney123/cloudcatalog/commits?author=perpil\" title=\"Documentation\"\u003e📖\u003c/a\u003e\u003c/td\u003e\n      \u003ctd align=\"center\" valign=\"top\" width=\"14.28%\"\u003e\u003ca href=\"http://www.ennovative-solutions.be\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/2007116?v=4?s=100\" width=\"100px;\" alt=\"Baerten Dennis\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eBaerten Dennis\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/boyney123/cloudcatalog/commits?author=debae\" title=\"Code\"\u003e💻\u003c/a\u003e \u003ca href=\"https://github.com/boyney123/cloudcatalog/commits?author=debae\" title=\"Documentation\"\u003e📖\u003c/a\u003e \u003ca href=\"#ideas-debae\" title=\"Ideas, Planning, \u0026 Feedback\"\u003e🤔\u003c/a\u003e\u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n  \u003ctfoot\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" size=\"13px\" colspan=\"7\"\u003e\n        \u003cimg src=\"https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg\"\u003e\n          \u003ca href=\"https://all-contributors.js.org/docs/en/bot/usage\"\u003eAdd your contributions\u003c/a\u003e\n        \u003c/img\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tfoot\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboyney123%2Fcloudcatalog","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboyney123%2Fcloudcatalog","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboyney123%2Fcloudcatalog/lists"}