README.md

 

Diagram.yml

About   |   Example   |   Technologies   |   Requirements   |   Starting   |   License   |   Author

🎯 About

Build diagram using yaml.

✨ Example

# YAML
# Default YAML Content
diagrams:
  - parent:
      shape: square
      text: Parent 1
      name: parent-1
      size: big
      children:
        - child:
            shape: circle
            text: Child 1-1
            name: child-1-1
            size: small
        - child:
            shape: circle
            text: Child 1-2
            name: child-1-2
            size: big
            children:
            - child:
                shape: square
                text: Child 1-1-2
                name: child-1-1-2
                size: big
        
                
links:
  - type: link
    data:
      from: child-1-1
      to: child-1-2
  - type: link
    data:
      from: child-1-1
      to: parent-1
  - type: link
    data:
      from: child-1-1-2
      to: child-1-2

🚀 Technologies

The following tools were used in this project:

• Vue.js
• Bulma

✅ Requirements

Before starting 🏁, you need to have Git and ViteJS installed.

🏁 Starting

# Clone this project
$ git clone https://github.com/AlchemiistCreative/diagram.yml

# Access
$ cd diagram.yml

# Install dependencies
$ npm install

# Run the project
$ npm run dev

# The server will initialize in the <http://localhost:5173> depending your vite configuration.

📝 License

This project is under license from MIT. For more details, see the LICENSE file.

Made with ❤️ by Thomas François

 

Back to top