dati-basati

KO | EN

gitlite — search

#javascript #ai #llm #android #docker #macos #nodejs #windows #cli #kubernetes #vue #awesome-list #security #open-source

(★ 10)

Typst package to draw Entity-Relations diagrams.

dati-basati 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Dati basati

![Version](https://img.shields.io/badge/package-v0.1.0-239dad?logo=typst)
[![Github Repo](https://img.shields.io/badge/github-repo-blue?logo=github)](https://github.com/victuarvi/dati-basati.git)
![License](https://img.shields.io/badge/license-GPLv3-green)
[![Manual](https://img.shields.io/badge/docs-manual.pdf-red?logo=readthedocs)](https://raw.githubusercontent.com/VictuarVi/dati-basati/main/docs/manual.pdf)

_Dati basati_ ("_Based Data_" in Italian) is a [Typst](https://typst.app/) package, built on [CeTZ](https://github.com/cetz-package/cetz), to draw ER-diagrams as I did during university. I was never able to find a software that did it, so why not do it myself?

See the `/docs` directory for the [manual](/docs/manual.pdf) and the [documentation](/docs/docs.pdf).

# Usage 🖋

See [this](/examples/example_quick.typ) for a quick start. You need to import the package into your project:

```typ
#import "@preview/dati-basati:0.1.0" as db
```

<p align="center">
  <img src="thumbnails/example_0.png"/>
</p>
<details>
  <summary>See the source code</summary>
  
```typ
// tiw

#set page(width: auto, height: auto, margin: 1cm)

#import "@preview/dati-basati:0.1.0" as db

#set text(font: "Barlow")

#show: db.dati-basati.with(..db.themes.tiw)

#let entities = (
  "user": (
    coordinates: (0, 0),
    attributes: (
      "north": ("user_id", "nickname", "password"),
      "west": ("name", "surname"),
    ),
    attributes-position: (
      north: (alignment: center),
    ),
    primary-key: "user_id",
    label: "user",
    name: "user",
  ),
  "playlist": (
    coordinates: (5, -5),
    attributes: (
      "south": ("title",),
      "north": ("creation_date",),
    ),
    attributes-position: (
      "north": (alignment: right),
      "south": (alignment: left),
    ),
    weak-entity: ("title", "west"),
    label: "playlist",
    name: "playlist",
  ),
  "track": (
    coordinates: (10, 0),
    attributes: (
      "north": ("track_id", "title", "artist", "album").rev(),
      "east": ("year", "image_path", "song_path"),
    ),
    attributes-position: (
      "north": (
        alignment: center,
        dir: "ltr",
      ),
    ),
    primary-key: "track_id",
    label: "track",
    name: "track",
  ),
)

#let relations = (
  "user-playlist": (
    coordinates: (0, -5),
    entities: ("user", "playlist"),
    label: "creates",
    name: "user-playlist",
    cardinality: ("(0,n)", "(1,1)"),
  ),
  "user-track": (
    entities: ("user", "track"),
    label: "uploads",
    name: "user-track",
    cardinality: ("(0,n)", "(1,1)"),
  ),
  "playlist-track": (
    coordinates: (10, -5),
    entities: ("playlist", "track"),
    label: "contains",
    name: "playlist-track",
    cardinality: ("(0,n)", "(0,n)"),
    attributes: ("east": ("custom_order",)),
  ),
)

#db.er-diagram({
  for entity in entities.values() {
    db.entity(
      entity.coordinates,
      label: entity.label,
      name: entity.name,
      attributes: entity.attributes,
      attributes-position: entity.at("attributes-position", default: none),
      primary-key: entity.at("primary-key", default: none),
      weak-entity: entity.at("weak-entity", default: none),
      misc: entity.at("misc", default: none),
    )
  }

for relation in relations.values() {
    db.relation(
      coordinates: relation.at("coordinates", default: none),
      entities: relation.entities,
      label: relation.at("label", default: none),
      name: relation.name,
      cardinality: relation.cardinality,
      attributes: relation.at("attributes", default: none),
    )
  }
})
```
</details>

# Showcase ✨

If you click on the images you can check the source code.

<p align="center">
  <a href="/examples/example_7.typ"><img alt="" src="thumbnails/example_7.png"></a>
  
</p>

<p align="center">
  <a href="/examples/example_14.typ"><img alt="" src="thumbnails/example_14.png"></a>
  
</p>

<p align="center">
  <a href="/examples/example_9.typ"><img alt="" src="thumbnails/example_9.png"></a>
  
</p>
<p align="center">
  <a href="/examples/example_10.typ"><img alt="" src="thumbnails/example_10.png"></a>
  
</p>

<p align="center">
  <a href="/examples/example_11.typ"><img alt="" src="thumbnails/example_11.png"></a>
  
</p>

See the [examples](/examples) directory for many exceptions and particular cases. Note that those files serve the _only_ purpose to illustrate how the package works: as such, they may contain errors and are NOT intended to be applied for database development.

# Roadmap 📝

- Type checking using [valkyrie](https://typst.app/universe/package/valkyrie)
- Better options coordination (in order to avoid visual errors)
- Local theming as opposed to the current global one

# Contributing 🚀

If you happen to have suggestions, ideas or anything else feel free to open issues and pull requests or contact me.

dati-basati

dati-basati 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

dati-basati

dati-basati 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README