k-kawa / erd Goto Github PK

Do you think template based is a better option for this erd project? The benefit is that you don't need to hard code your graph, and people have more freedom to tweak to their liking.

If so, check out the various templates I listed in xo/xo#31.

I know this project is still under PoC, so here is my 2c on the syntax.

Your current table definition syntax is in JSON form, and it might not have been able to cover every ERD cases possible. This will cause problem for it to be widely adapted, especially if there is a well defined table Schema definition already exist, and backed by big organizations like Red Hat. And the problem is, such thing does exist:

JSON Schema
http://json-schema.org/

The Go code is at,
https://github.com/xeipuuv/gojsonschema
By Suraj Deshmukh from Red Hat

You can find some json-schema examples at
http://json-schema.org/examples.html

Also, you can see that it has been already widely adapted, by big names like docker:
https://github.com/docker/compose/blob/master/compose/config/config_schema_v3.0.json

So I think you'd better stand on this giant's shoulder instead.

my 2c though.

Hola! @k-kawa has created a ZenHub account for the k-kawa organization. ZenHub is the only project management tool integrated natively in GitHub – created specifically for fast-moving, software-driven teams.

How do I use ZenHub?

To get set up with ZenHub, all you have to do is download the browser extension and log in with your GitHub account. Once you do, you’ll get access to ZenHub’s complete feature-set immediately.

What can ZenHub do?

ZenHub adds a series of enhancements directly inside the GitHub UI:

• Real-time, customizable task boards for GitHub issues;
• Multi-Repository burndown charts, estimates, and velocity tracking based on GitHub Milestones;
• Personal to-do lists and task prioritization;
• Time-saving shortcuts – like a quick repo switcher, a “Move issue” button, and much more.

Add ZenHub to GitHub

Still curious? See more ZenHub features or read user reviews. This issue was written by your friendly ZenHub bot, posted by request from @k-kawa.

This feature will help me cope with undocumented projects.
and it can be so nice if it can export schema data in the erd format

The line starting with "#" should be ignored as a comment line.

It becomes very easy to write another tool working with the erd file if this tool can export data in JSON format.