Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 1.89 KB

README.md

File metadata and controls

60 lines (47 loc) · 1.89 KB

Welcome to uml-kodyfire 👋

Version Maintenance Twitter: anis_marrouchi

A uml diagram generator using kodyfire.

Prerequisites

Make sure you have kodyfire-cli intalled globally.

npm i -g kodyfire-cli

Install

Add uml-kodyfire as an npm dependency to your project

npm i -s uml-kodyfire

Usage

Method 1: As a generator

In order to generate your artifacts, run the generate command. The syntax is kody generate|g [kody] [concept]. If you ommit kody and concept the assistant will prompt you to select them. As an example, run the following command from your terminal:

kody generate react component

Method 2: As a kody project

Refer to the kodyfire generate your artifact section

npm i -s uml-kodyfire

Once you are ready to run your definition file, generate your uml's using:

kody run -s uml-kody.json

Features

  • Class diagrams (basic)
  • Use Case diagrams (basic)
  • Sequence diagrams (In progress)
  • Acitivity diagram (In progress)

License

Copyright © 2022 Anis Marrouchi.

This project is MIT licensed.

This README was generated with ❤️ by readme-kodyfire