Giter Club home page Giter Club logo

keadex-einaudi's Introduction

Keadex Battisti Logo

Experiment. Learn. Share.


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 ( โœ… ).

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.

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-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-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-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)

keadex-einaudi's People

Contributors

keadex avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.