Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CALM Visualizer to README / CodeOwners #792

Merged
merged 5 commits into from
Jan 15, 2025
Merged

Add CALM Visualizer to README / CodeOwners #792

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
78753b3
#788 Add entry for CALM visualiser
oliviajanejohns Jan 10, 2025
ae4efe6
#788 Updated README
oliviajanejohns Jan 10, 2025
fbf7661
Added tailwind typography to CALM visualizer
oliviajanejohns Jan 13, 2025
b55eac6
#778 Update styling of Visualizer
oliviajanejohns Jan 14, 2025
b9e60a6
Updated Visualizer README
oliviajanejohns Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

/cli/ @aidanm3341 @lbulanti-ms @willosborne @grahampacker-ms @jpgough-ms @rocketstack-matt @Thels

/calm-visualizer/ @oliviajanejohns @aidanm3341 @aamanrebello @yoofitt96

/shared/ @aidanm3341 @lbulanti-ms @willosborne @grahampacker-ms @jpgough-ms @rocketstack-matt @Thels

/translator/ @Budlee @matthewgardner @jpgough-ms @rocketstack-matt
2 changes: 2 additions & 0 deletions .github/labeler.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ calm-hub:
- "calm-hub/**"
calm:
- "calm/**"
calm-visualizer:
- "calm-visualizer/**"
config:
- "pom.xml"
- "**/package.json"
Expand Down
16 changes: 7 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,13 @@ your project.

## Projects

| Project | Lead Maintainers | Builds |
|----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Common Architecture Language Model](./calm) | [@rocketstack-matt](https://github.com/rocketstack-matt), [@jpgough-ms](https://github.com/jpgough-ms) | [![Validation of CALM Samples](https://github.com/finos/architecture-as-code/actions/workflows/validate-spectral.yml/badge.svg)](https://github.com/finos/architecture-as-code/actions/workflows/validate-spectral.yml) |
| [Docs](./docs) | [@rocketstack-matt](https://github.com/rocketstack-matt) | [![Sync Docs to S3](https://github.com/finos/architecture-as-code/actions/workflows/s3-docs-sync.yml/badge.svg)](https://github.com/finos/architecture-as-code/actions/workflows/s3-docs-sync.yml) [![Build Docs](https://github.com/finos/architecture-as-code/actions/workflows/build-docs.yml/badge.svg)](https://github.com/finos/architecture-as-code/actions/workflows/build-docs.yml) |
| [CLI](./cli) & [Shared](./shared) | [@aidanm3341](https://github.com/aidanm3341), [@lbulanti-ms](https://github.com/lbulanti-ms), [@willosborne](https://github.com/willosborne), [@grahampacker-ms](https://github.com/grahampacker-ms) [@Thels](https://github.com/Thels) | [![Build CLI](https://github.com/finos/architecture-as-code/actions/workflows/build-cli.yml/badge.svg)](https://github.com/finos/architecture-as-code/actions/workflows/build-cli.yml)|
| [Translators](./translator) | [@Budlee](https://github.com/Budlee) [@matthewgardner](https://github.com/matthewgardner) [@jpgough-ms](https://github.com/jpgough-ms) | [![Build Translator](https://github.com/finos/architecture-as-code/actions/workflows/build-translator.yml/badge.svg)](https://github.com/finos/architecture-as-code/actions/workflows/build-translator.yml) |
| Project | Lead Maintainers | Builds |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Common Architecture Language Model](./calm) | [@rocketstack-matt](https://github.com/rocketstack-matt), [@jpgough-ms](https://github.com/jpgough-ms) | [![Validation of CALM Samples](https://github.com/finos/architecture-as-code/actions/workflows/validate-spectral.yml/badge.svg)](https://github.com/finos/architecture-as-code/actions/workflows/validate-spectral.yml) |
| [Docs](./docs) | [@rocketstack-matt](https://github.com/rocketstack-matt) | [![Sync Docs to S3](https://github.com/finos/architecture-as-code/actions/workflows/s3-docs-sync.yml/badge.svg)](https://github.com/finos/architecture-as-code/actions/workflows/s3-docs-sync.yml) [![Build Docs](https://github.com/finos/architecture-as-code/actions/workflows/build-docs.yml/badge.svg)](https://github.com/finos/architecture-as-code/actions/workflows/build-docs.yml) |
| [CLI](./cli) & [Shared](./shared) | [@aidanm3341](https://github.com/aidanm3341), [@lbulanti-ms](https://github.com/lbulanti-ms), [@willosborne](https://github.com/willosborne), [@grahampacker-ms](https://github.com/grahampacker-ms) [@Thels](https://github.com/Thels) | [![Build CLI](https://github.com/finos/architecture-as-code/actions/workflows/build-cli.yml/badge.svg)](https://github.com/finos/architecture-as-code/actions/workflows/build-cli.yml) |
| [Visualizer](./calm-visualizer) | [@oliviajanejohns](https://github.com/oliviajanejohns) [@aidanm3341](https://github.com/aidanm3341) [@aamanrebello](https://github.com/aamanrebello) [@yoofitt96](https://github.com/YoofiTT96) |
| [Translators](./translator) | [@Budlee](https://github.com/Budlee) [@matthewgardner](https://github.com/matthewgardner) [@jpgough-ms](https://github.com/jpgough-ms) | [![Build Translator](https://github.com/finos/architecture-as-code/actions/workflows/build-translator.yml/badge.svg)](https://github.com/finos/architecture-as-code/actions/workflows/build-translator.yml) |

## Getting Involved

Expand Down Expand Up @@ -58,22 +59,19 @@ We accept contributions via Pull Request, to make a contribution:
6. Push to the branch (`git push origin feature/fooBar`)
7. Create a new Pull Request


## GitHub actions

There aren't many standards to follow when it comes to Github actions - but some good rules of thumb for this project are;

- GitHub actions should follow the naming conventions of pre-existing actions to maintain consistency. So that users can find other build-related steps in the same place.
- Ensure that any obscure actions are documented so that others can follow and maintain them.


## Language Dependencies

### TypeScript Packages

Currently we have three typescript packages - two of which are managed via `npm workspaces` and one which is just raw `npm`. How these are built and manages slightly differs until they are all under the same worksapce - please look at their related github actions to learn how to build/test each of them.


## License

Copyright 2024 FINOS
Expand Down
2 changes: 1 addition & 1 deletion calm-visualizer/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!doctype html>
<html lang="en" data-theme="cupcake">
<html lang="en" data-theme="emerald">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
Expand Down
45 changes: 45 additions & 0 deletions calm-visualizer/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions calm-visualizer/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
},
"devDependencies": {
"@eslint/js": "^9.14.0",
"@tailwindcss/typography": "^0.5.16",
"@testing-library/jest-dom": "^6.6.3",
"@testing-library/react": "^16.1.0",
"@testing-library/user-event": "^14.5.2",
Expand Down
5 changes: 3 additions & 2 deletions calm-visualizer/src/components/cytoscape-renderer/CytoscapeRenderer.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,8 +169,9 @@ const CytoscapeRenderer = ({
return (
<div className="relative flex m-auto border">
{title && (
<div className="graph-title absolute m-5 bg-primary-content shadow-md">
<span className="text-m">Architecture: {title}</span>
<div className="graph-title absolute m-5 bg-primary shadow-md">
<span className="text-m font-thin">Architecture: </span>
<span className="text-m font-semibold">{title}</span>
</div>
)}
<div
Expand Down
4 changes: 0 additions & 4 deletions calm-visualizer/src/components/cytoscape-renderer/cytoscape.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,3 @@
margin-top: 10px;
color: black;
}

.relationship-label {
background-color: white;
}
16 changes: 10 additions & 6 deletions calm-visualizer/src/components/navbar/Navbar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,19 +18,19 @@ function Navbar({
};

return (
<div className="navbar bg-base-300">
<div className="navbar bg-secondary text-secondary-content">
<div className="flex-1">
<a className="btn btn-ghost text-xl">CALM</a>
<a className="btn btn-ghost text-2xl">CALM</a>
<div className="divider divider-horizontal"></div>
<span className="text-lg">Visualizer</span>
<span className="text-lg font-thin">Visualizer</span>
</div>
<div className="flex-none">
<ul className="menu menu-horizontal px-1" aria-label="navbar-menu-items">
<li>
<details>
<summary>Upload</summary>
<ul className="p-2 z-1" aria-label="upload-dropdown-items">
<li>
<li className=" text-secondary">
<label>
Architecture
<input
Expand All @@ -54,7 +54,9 @@ function Navbar({
<div className="divider divider-horizontal"></div>
<div className="toggles menu-horizontal">
<label className="label cursor-pointer">
<span className="label label-text">Connection Descriptions</span>
<span className="label label-text text-secondary-content">
Connection Descriptions
</span>
<input
type="checkbox"
className="toggle"
Expand All @@ -64,7 +66,9 @@ function Navbar({
/>
</label>
<label className="label cursor-pointer">
<span className="label label-text">Node Descriptions</span>
<span className="label label-text text-secondary-content">
Node Descriptions
</span>
<input
type="checkbox"
className="toggle"
Expand Down
33 changes: 16 additions & 17 deletions calm-visualizer/src/components/sidebar/Sidebar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,23 +40,20 @@ function Sidebar({ selectedData, closeSidebar }: SidebarProps) {
<div className="text-xl font-bold mb-2">Node Details</div>
<div className="space-y-2">
<p>
<span className="font-semibold">unique-id: {selectedData.id}</span>
<span className="font-light">unique-id: </span>
<span className="font-semibold">{selectedData.id}</span>
</p>

<p>
<span className="font-semibold">name: {selectedData.label}</span>
<span className="font-light">name: </span>
<span className="font-semibold">{selectedData.label}</span>
</p>

<p>
<span className="font-semibold">
node-type: {selectedData.type}
</span>
<span className="font-light">node-type: </span>
<span className="font-semibold">{selectedData.type}</span>
</p>

<p>
<span className="font-semibold">
description: {selectedData.description}
</span>
<span className="font-light">description: </span>
<span className="font-semibold">{selectedData.description}</span>
</p>
</div>
</div>
Expand All @@ -67,21 +64,23 @@ function Sidebar({ selectedData, closeSidebar }: SidebarProps) {
<div className="text-xl font-bold mb-2">Edge Details</div>
<div className="space-y-2">
<p>
<span className="font-semibold">unique-id: {selectedData.id}</span>
<span className="font-light">unique-id: </span>
<span className="font-semibold">{selectedData.id}</span>
</p>

<p>
<span className="font-semibold">
description: {selectedData.label}
</span>
<span className="font-light">description: </span>
<span className="font-semibold">{selectedData.label}</span>
</p>

<p>
<span className="font-semibold">source: {selectedData.source}</span>
<span className="font-light">source: </span>
<span className="font-semibold">{selectedData.label}</span>
</p>

<p>
<span className="font-semibold">target: {selectedData.target}</span>
<span className="font-light">target: </span>
<span className="font-semibold">{selectedData.target}</span>
</p>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions calm-visualizer/tailwind.config.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ module.exports = {
theme: {
extend: {},
},
plugins: [require('daisyui')],
plugins: [require('@tailwindcss/typography'), require('daisyui')],
daisyui: {
themes: ["light", "dark", "cupcake"],
themes: ['light', 'dark', 'emerald'],
},
};
Loading