oss-directory icon indicating copy to clipboard operation
oss-directory copied to clipboard
verified publisher icon opensource-observer

Add Db schema

Open IperGiove opened this issue 1 year ago • 4 comments

This PR introduces the database schema as a visual diagram and a DBML file.

Changes

  • Added schema.png to src/resources/.data/.
  • Added schema.dbml to src/resources/.data/.
  • Updated README.md to include the database schema image.

IperGiove avatar May 27 '24 08:05 IperGiove

Validation Results

✅ Good to go as long as status checks pass

commit 98151abd37b6e973e1aa7e76fb9ba73d2e59db85

oso-prs[bot] avatar May 27 '24 08:05 oso-prs[bot]

I really like this idea! Though I would much prefer that we programmatically generate it, rather than have to try to keep it consistent.

Is there a library that will convert json schema to dbml, which we can add as a build step to the package.json?

ryscheng avatar May 27 '24 19:05 ryscheng

It makes sense to automate the process, but unfortunately, DBML is designed for SQL and doesn't have a JSON parser. I'm not sure if there is a visualizer available that can work with a JSON file

IperGiove avatar May 28 '24 06:05 IperGiove

I'm just concerned that anything that's not programmatically generated will get out of date and will be a burden to keep up-to-date.

How about using something like this instead? https://www.npmjs.com/package/@adobe/jsonschema2md

ryscheng avatar May 28 '24 11:05 ryscheng