Skip to content

keadex/keadex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Keadex Battisti Logo

Experiment. Learn. Share.


Important

Maintaining open-source solutions demands significant effort, especially since it’s not my primary job. However, Keadex is my passion, and I genuinely enjoy working on it.

If you like Keadex applications or libraries, I’m not asking for a coffee or a donation.
Instead, I'd appreciate if you just ⭐ star this repository and 📣 share it with your teams, colleagues, or community! Thank you!

Introduction

Keadex is a project that aims to experiment, learn and provide open source solutions.

Some of the packages in this repo are experiments ( 🔬 ), some under development ( ⏳ ), while others are ready to use open source solutions ( ✅ ).

💡 Do you have ideas you’d like to share? Are you interested in contributing to Keadex or learning more about it? Feel free to reach out to me on my Discord channel, or explore the Keadex website and documentation for more information!

Packages

Applications

Type Package Short Description Version Language(s) Framework(s)
apps/keadex-battisti Keadex Website & Documentation Platform. GitHub package.json version (subfolder of monorepo) Typescript, MDX Next.js, Nextra, Tailwing CSS
apps/keadex-diagrams Keadex architectural diagrams. GitHub package.json version (subfolder of monorepo) PlantUML, JSON Keadex Mina
apps/keadex-mina Desktop app to create and manage C4 Model diagrams. GitHub package.json version (subfolder of monorepo) Typescript, Rust Tauri, React, Tailwind CSS
apps/mina-confluence-app Custom Confluence UI integrated into the Confluence Mina plugin. GitHub package.json version (subfolder of monorepo) Typescript React, Atlassian Forge

Libraries

Type Package Short Description Version Language(s) Framework(s)
libs/c4-model-ui-kit Library that provides UI components to render C4 Model diagrams. GitHub package.json version (subfolder of monorepo) Typescript Fabric.js
libs/docusaurus-plugin-mina Library that provides the plugin to render Keadex Mina diagrams into Docusaurus. GitHub package.json version (subfolder of monorepo) Typescript React, Docusaurus
libs/keadex-nx-plugin Library that provides the Nx plugin with Keadex executors and generators. GitHub package.json version (subfolder of monorepo) Typescript Nx
libs/keadex-ui-kit Library that provides UI components to render Keadex applications. GitHub package.json version (subfolder of monorepo) Typescript React, Tailwind CSS
libs/keadex-utils Library that provides general purpose utilities. GitHub package.json version (subfolder of monorepo) Typescript
libs/mina-confluence-plugin Library that provides the Confluence Macro to render Keadex Mina diagrams into Confluence. GitHub package.json version (subfolder of monorepo) Typescript Atlassian Forge
libs/mina-cli Library that provides the CLI to interact with Mina projects. Dynamic TOML Badge Rust
libs/mina-react Library that provides a React component to include Keadex Mina diagrams into React apps. GitHub package.json version (subfolder of monorepo) Typescript, WASM React, Tailwind CSS

Examples

Warning

Examples are not part of the Yarn workspace. Befor running an example make sure to install the dependencies (yarn install) in the root folder of the example.

Package Description
examples/mina-react-example Example to demonstrate how to integrate the Mina React component to render interactive C4 Model diagrams created with Keadex Mina.
examples/mina-docusaurus-example Example to demonstrate how to include in Docusaurus pages, interactive C4 Model diagrams created with Keadex Mina.

Get Started

This is a monorepo managed with Nx.

To start working on it:

  • clone the repo: git clone https://github.com/keadex/keadex.git
  • install the dependencies: yarn
  • check the project.json file of each application or library for the list of the available Nx targets (commands can be executed - e.g. yarn nx dev keadex-mina)