Experiment. Learn. Share.
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 ( ✅ ).
If you're interested in knowing more about Keadex, me or the provided solutions please visit keadex.dev, the documentation section or the Discord channel.
Type | Package | Short Description | Version | Language(s) | Framework(s) |
---|---|---|---|---|---|
✅ | apps/keadex-battisti | Keadex Website & Documentation Platform. | Typescript, MDX | Next.js, Nextra, Tailwing CSS | |
✅ | apps/keadex-diagrams | Keadex architectural diagrams. | 1.0.0 | PlantUML, JSON | Keadex Mina |
✅ | apps/keadex-mina | Desktop app to create and manage C4 Model diagrams. | Typescript, Rust | Tauri, React, Tailwind CSS | |
✅ | apps/mina-confluence-app | Custom Confluence UI integrated into the Confluence Mina plugin. | Typescript | React, Atlassian Forge |
Type | Package | Short Description | Version | Language(s) | Framework(s) |
---|---|---|---|---|---|
✅ | libs/c4-model-ui-kit | Library that provides UI components to render C4 Model diagrams. | Typescript | Fabric.js | |
✅ | libs/docusaurus-plugin-mina | Library that provides the plugin to render Keadex Mina diagrams into Docusaurus. | Typescript | React, Docusaurus | |
✅ | libs/keadex-nx-plugin | Library that provides the Nx plugin with Keadex executors and generators. | Typescript | Nx | |
✅ | libs/keadex-ui-kit | Library that provides UI components to render Keadex applications. | Typescript | React, Tailwind CSS | |
✅ | libs/keadex-utils | Library that provides general purpose utilities. | Typescript | ||
✅ | libs/mina-confluence-plugin | Library that provides the Confluence Macro to render Keadex Mina diagrams into Confluence. | Typescript | Atlassian Forge | |
✅ | libs/mina-react | Library that provides a React component to include Keadex Mina diagrams into React apps. | Typescript, WASM | React, Tailwind CSS |
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. |
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
)