first commit

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": ["@changesets/changelog-github", { "repo": "boyney123/cloudcatalog-test" }],
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/CODEOWNERS

@@ -0,0 +1,3 @@
+# https://help.github.com/articles/about-codeowners/
+
+* @boyney123

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1 @@
+## 👉 [Please follow one of these issue templates](https://github.com/boyney123/cloudcatalog/issues/new/choose) 👈

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,18 @@
+<!--
+Thank you for sending the PR! We appreciate you spending the time to work on these changes.
+
+Help us understand your motivation by explaining why you decided to make this change.
+
+You can learn more about contributing to Cloudcatalog here: https://github.com/boyney123/cloudcatalog/blob/main/CONTRIBUTING.md
+
+Happy contributing!
+
+-->
+
+## Motivation
+
+(Write your motivation here.)
+
+### Have you read the [Contributing Guidelines on pull requests](https://github.com/boyney123/cloudcatalog/blob/master/CONTRIBUTING.md#pull-requests)?
+
+(Write your answer here.)

.github/workflows/lint.yml

@@ -0,0 +1,27 @@
+name: Lint
+
+on:
+  pull_request:
+    branches:
+      - master
+      - main
+
+jobs:
+  lint:
+    name: Lint
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v2
+        with:
+          cache: 'npm'
+          node-version: '16.14.0'
+      - name: Installation
+        run: npm install
+      # - name: Check immutable package-lock.json
+      #   run: git diff --exit-code
+      - name: Lint
+        run: npm run lint:ci
+      - name: Prettier Code
+        run: npm run format:diff

.github/workflows/release.yml

@@ -0,0 +1,31 @@
+name: Release
+on:
+  push:
+    branches:
+      - master
+      - next
+      - main
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    if: github.repository == 'boyney123/cloudcatalog-test'
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Use Node.js 16.x
+        uses: actions/setup-node@v1
+        with:
+          version: 16.x
+
+      - name: Install deps and build (with cache)
+        uses: bahmutov/npm-install@v1
+
+      - name: Create Release Pull Request or Publish to npm
+        uses: changesets/action@master
+        with:
+          publish: npm run publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.github/workflows/tests.yml

@@ -0,0 +1,29 @@
+name: Tests
+
+on:
+  pull_request:
+    branches:
+      - master
+      - main
+    paths-ignore:
+      - website/**
+
+jobs:
+  test:
+    name: Tests
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node: ['16', '18']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+          cache: npm
+      - name: Installation
+        run: npm i
+      - name: Test
+        run: npm run test

.github/workflows/verify-build.yml

@@ -0,0 +1,26 @@
+# Make sure the EventCatalog can build OK
+name: Verify Build
+
+on:
+  pull_request:
+    branches:
+      - master
+      - main
+
+jobs:
+  build:
+    name: Verify Build
+    timeout-minutes: 30
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v2
+        with:
+          cache: npm
+          node-version: '16'
+      - name: Installation
+        run: npm i
+      # - name: Check immutable lock
+      #   run: git diff --exit-code
+      - name: Build
+        run: npm run verify-build:catalog

.gitignore

@@ -0,0 +1,39 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+node_modules
+.pnp
+.pnp.js
+
+# testing
+coverage
+
+# next.js
+.next/
+out/
+build
+
+backupp/
+
+# misc
+.DS_Store
+*.pem
+
+/packages/**/dist
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# turbo
+.turbo
+
+/packages/awscatalog/awscatalog.config.js

README.md

@@ -0,0 +1,108 @@
+<div align="center">
+
+<h1>📖 CloudCatalog</h1>
+<p>Discover, Explore and Document your AWS Architectures.</p>
+
+<!-- [![MIT License][license-badge]][license] -->
+<!-- [![PRs Welcome][prs-badge]][prs] -->
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+<!-- [![All Contributors](https://img.shields.io/badge/all_contributors-32-orange.svg?style=flat-square)](#contributors-) -->
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
+
+[![Watch on GitHub][github-watch-badge]][github-watch]
+[![Star on GitHub][github-star-badge]][github-star]
+
+<hr />
+
+<img alt="header" src="https://github.com/boyney123/cloudcatalog/blob/master/website/static/img/screenshot.png?raw=true" />
+
+  <h3>Features: Website generator for AWS Architectures, Markdown driven, Document Resources/Services/Owners, and more...</h3>
+
+[Read the Docs](https://cloudcatalog.dev/) | [Edit the Docs](https://github.com/boyney123/cloudcatalog) | [View Demo](https://cloudcatalog-demo-app.vercel.app/)
+
+</div>
+
+<hr/>
+
+# Core Features
+
+- 🔎 Import Resources
+- 📃 Document Resources, Services, Teams
+- 📊 Visualise Resources
+- 🗄️ Powered by markdown
+- 📑 Keep up to date
+- ⭐ And much more...
+
+**All powered by markdown**
+
+# The problem
+
+In 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.
+
+When 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?
+
+What if we could:
+
+- Document resources in seconds
+- Use Markdown to document our architecture.
+- Enrich our documentation with custom components
+- Group AWS resources in services and assign owners (users or teams) to them
+- Help developers understand our architecture with simple diagrams and markdown content, and more...
+
+Say hello to CloudCatalog.
+
+**CloudCatalog is designed to help people understand, document and discover their AWS Architectures.**
+
+We can do so much more to document our Architectures.
+
+CloudCatalog is Open Source and hopefully it can add value to your teams.
+
+
+# This solution
+
+<!-- <img alt="header" src="./images/architecture-2.png" /> -->
+
+Think of CloudCatalog as a website generator that allows you to document your architectures with markdown files.
+
+Markdown files are quite a popular tool to help us document content, so why not use markdown files to document our resources and services?
+
+You can read more on [how it works on the website](https://cloudcatalog.dev)
+
+# Getting Started
+
+You should be able to get setup within minutes if you head over to our documentation to get started 👇
+
+➡️ [Get Started](https://cloudcatalog.dev/docs/overview/getting-started/installation)
+
+Or run this command to build a new catalog
+
+```
+npx @cloudcatalog/create-cloudcatalog@latest my-cloudcatalog
+```
+
+# Demo
+
+Here is an example of a CloudCatalog hosting a few teams, users and Lambda resources.
+
+[app.cloudcatalog.dev](https://cloudcatalog-demo-app.vercel.app/)
+
+You can see the markdown files that generated the website in the GitHub repo under [examples](/examples).
+
+# Contributing
+
+If 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.
+
+[license-badge]: https://img.shields.io/github/license/boyney123/cloudcatalog.svg?color=yellow
+[license]: https://github.com/boyney123/cloudcatalog/blob/master/LICENSE
+[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
+[prs]: http://makeapullrequest.com
+[github-watch-badge]: https://img.shields.io/github/watchers/boyney123/cloudcatalog.svg?style=social
+[github-watch]: https://github.com/boyney123/cloudcatalog/watchers
+[github-star-badge]: https://img.shields.io/github/stars/boyney123/cloudcatalog.svg?style=social
+[github-star]: https://github.com/boyney123/cloudcatalog/stargazers
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+# License
+
+MIT.

examples/default/cloudcatalog.config.js

@@ -0,0 +1,35 @@
+module.exports = {
+  title: 'CloudCatalog',
+  tagline: 'Discover, Explore and Document your AWS Architectures',
+  organizationName: 'Your Company',
+  editUrl: 'https://github.com/boyney123/cloudcatalog-demo/edit/master',
+  trailingSlash: true,
+  logo: {
+    alt: 'CloudCatalog Logo',
+    src: 'logo.svg',
+  },
+  openGraph: {
+    ogTitle: 'CloudCatalog | Discover, Explore and Document your AWS Architecture',
+    ogDescription: 'An open source tool powered by markdown to document your AWS architecture.',
+    ogUrl: 'https://cloudcatalog.dev/',
+    ogImage: 'https://cloudcatalog.dev/img/opengraph.png',
+  },
+  users: [
+    {
+      id: 'dboyne',
+      name: 'David Boyne',
+      avatarUrl: 'https://pbs.twimg.com/profile_images/1262283153563140096/DYRDqKg6_400x400.png',
+      role: 'Developer',
+      summary: 'Currently building tools for Event Architectures.',
+      teams: ['payment-team'],
+    },
+    {
+      id: 'mSmith',
+      name: 'Matthew Smith',
+      avatarUrl: 'https://randomuser.me/api/portraits/lego/3.jpg',
+      role: 'Developer',
+      summary: 'About Fugiat ipsum ipsum deserunt culpa aute sint do nostrud anim incididunt cillum culpa consequat.',
+      teams: ['user-team'],
+    },
+  ],
+};