{"id":27255911,"url":"https://github.com/nestorrente/erdiagram","last_synced_at":"2025-04-11T02:48:44.176Z","repository":{"id":57129936,"uuid":"333167194","full_name":"nestorrente/erdiagram","owner":"nestorrente","description":"Entity-Relationship diagram code generator library","archived":false,"fork":false,"pushed_at":"2024-09-12T09:00:23.000Z","size":4201,"stargazers_count":49,"open_issues_count":5,"forks_count":14,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-15T12:00:37.605Z","etag":null,"topics":["diagram","entity","erdiagram","generation","java","javascript","js","mysql","nomnoml","oracle","oracledb","plantuml","postgres","postgresql","relationship","sql","sqlite","sqlserver","ts","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nestorrente.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-26T17:46:40.000Z","updated_at":"2024-09-18T12:05:43.000Z","dependencies_parsed_at":"2024-09-10T21:45:16.420Z","dependency_job_id":"1603133b-210b-4c06-b198-5d4f2fcf9e9a","html_url":"https://github.com/nestorrente/erdiagram","commit_stats":{"total_commits":239,"total_committers":3,"mean_commits":79.66666666666667,"dds":0.297071129707113,"last_synced_commit":"f6c7ac44e076e768e164d7ceb77ab2dcd435b31c"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestorrente%2Ferdiagram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestorrente%2Ferdiagram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestorrente%2Ferdiagram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nestorrente%2Ferdiagram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nestorrente","download_url":"https://codeload.github.com/nestorrente/erdiagram/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248332541,"owners_count":21086086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["diagram","entity","erdiagram","generation","java","javascript","js","mysql","nomnoml","oracle","oracledb","plantuml","postgres","postgresql","relationship","sql","sqlite","sqlserver","ts","typescript"],"created_at":"2025-04-11T02:48:43.599Z","updated_at":"2025-04-11T02:48:44.146Z","avatar_url":"https://github.com/nestorrente.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ERDiagram\n\n\u003e Define an _entity-relationship diagram_, then generate the database creation script, OOP classes, and much more!\n\n[![License](https://img.shields.io/npm/l/make-coverage-badge.svg)](https://opensource.org/licenses/MIT)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](CODE_OF_CONDUCT.md)\n\n[comment]: \u003c\u003e ([![npm]\u0026#40;https://img.shields.io/npm/dw/@nestorrente/erdiagram.svg\u0026#41;]\u0026#40;https://www.npmjs.com/package/@nestorrente/erdiagram\u0026#41;)\n\n![Coverage statements](coverage/badge-statements.svg)\n![Coverage branches](coverage/badge-branches.svg)\n![Coverage functions](coverage/badge-functions.svg)\n![Coverage lines](coverage/badge-lines.svg)\n\n## Table of contents\n\n* [Live demo \u0026 CLI](#live-demo--cli)\n* [Installation](#installation)\n  + [Installation steps for users](#installation-steps-for-users)\n  + [Installation steps for contributors](#installation-steps-for-contributors)\n* [Documentation](#documentation)\n* [Contributing](#contributing)\n  + [Wish list](#wish-list)\n\n## Live demo \u0026 CLI\n\nYou can try _ERDiagram_ online using the [ERDiagram playground](http://erdiagram.nestorrente.com/) application. There\nyou will find some code examples that are very useful for learning the _ERDiagram_ language.\n\nThere is also a _work-in-progress_ [CLI version of _ERDiagram_](https://github.com/nestorrente/erdiagram-cli). Check it\nout! 🙂\n\n## Installation\n\n### Installation steps for users\n\nYou can find the installation steps of the library in the\n[Library usage](docs/Library_usage.md#installation) document.\n\n### Installation steps for contributors\n\n#### Download the project\n\n1. Clone the repository\n\n```shell\ngit clone https://github.com/nestorrente/erdiagram.git\n```\n\n2. Access to the project's directory\n\n```shell\ncd erdiagram\n```\n\n3. Install dependencies\n\n```shell\nnpm install\n```\n\n#### Run tests and build\n\nFor running the tests and generating the badges for the README file, you can use the following command:\n\n```shell\nnpm run test\n```\n\nFor building the library, you can use the following command:\n\n```shell\nnpm run build\n```\n\n## Documentation\n\n* **[ERDiagram language](docs/ERDiagram_language.md)**: learn how to define entities and relationships.\n* **[ERDiagram library](docs/Library_usage.md)**: installation, basic concepts, configuration and examples.\n\n\n* Entity-relationship model conversion:\n  * **[Database model](docs/Database_model.md)**: learn how entities and relationships are modeled as tables and columns.\n  * **[Class model](docs/Class_model.md)**: learn how entities and relationships are modeled as OOP classes.\n\n\n* Supported output formats:\n  * Database creation script (SQL):\n    * MySQL\n    * Oracle DB\n    * PostgreSQL\n    * SQLite\n    * SQL Server\n  * OOP classes/interfaces:\n    * Java (includes Bean Validation and JPA support)\n    * TypeScript\n  * Diagram code:\n    * PlantUML\n    * Nomnoml\n\n## Contributing\n\nThis is a side project I'm working on during my spare time, so I'd be very happy if you want to contribute 😀\nbug report, suggestions, pull requests, or any other kind of feedback are really appreciated.\n\nPlease contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch from the `develop`\none, add commits, and [open a pull request](https://github.com/nestorrente/erdiagram/compare).\n\nPlease note we have a [code of conduct](CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.\n\nIf you want to get in touch with the author, you can contact me through\n[LinkedIn](https://www.linkedin.com/in/nestorpglez/) or [email](mailto:nestorpglez@gmail.com).\n\n### Wish list\n\nThis is a small list of features/tools that I'll be very happy to have:\n\n* More database engines support.\n* More OOP languages support.\n* ERDiagram language syntax highlight support for popular text editors or IDEs (Sublime Text, Jetbrains, VS Code, ...).\n* XSD / JSON schema generation.\n* Liquibase files generation.\n* Any other cool stuff 😛\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnestorrente%2Ferdiagram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnestorrente%2Ferdiagram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnestorrente%2Ferdiagram/lists"}