npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@nestorrente/erdiagram

v1.1.0

Published

Entity-Relationship Diagram Code Generator

Downloads

29

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

nestorrentenestorrente

Keywords

erdiagramerdentityrelationshipentity-relationshipdiagramsqlmysqlsqlservermicrosoftpostgrespostgresqloracleoracledbsqlitejavatypescripttsjavascriptjsnomnomlplantumlcodegenerationgenerator

Readme

ERDiagram

Define an entity-relationship diagram, then generate the database creation script, OOP classes, and much more!

License Contributor Covenant

Coverage statements Coverage branches Coverage functions Coverage lines

Table of contents

Live demo & CLI

You can try ERDiagram online using the ERDiagram playground application. There you will find some code examples that are very useful for learning the ERDiagram language.

There is also a work-in-progress CLI version of ERDiagram. Check it out! :slightly_smiling_face:

Installation

Installation steps for users

You can find the installation steps of the library in the Library usage document.

Installation steps for contributors

Download the project

  1. Clone the repository
git clone https://github.com/nestorrente/erdiagram.git
  1. Access to the project's directory
cd erdiagram
  1. Install dependencies
npm install

Run tests and build

For running the tests and generating the badges for the README file, you can use the following command:

npm run test

For building the library, you can use the following command:

npm run build

Documentation

  • ERDiagram language: learn how to define entities and relationships.

  • ERDiagram library: installation, basic concepts, configuration and examples.

  • Entity-relationship model conversion:

    • Database model: learn how entities and relationships are modeled as tables and columns.
    • Class model: learn how entities and relationships are modeled as OOP classes.

  • Supported output formats:

    • Database creation script (SQL):
      • MySQL
      • Oracle DB
      • PostgreSQL
      • SQLite
      • SQL Server
    • OOP classes/interfaces:
      • Java (includes Bean Validation and JPA support)
      • TypeScript
    • Diagram code:
      • PlantUML
      • Nomnoml

Contributing

This is a side project I'm working on during my spare time, so I'd be very happy if you want to contribute :grinning: bug report, suggestions, pull requests, or any other kind of feedback are really appreciated.

Please contribute using GitHub Flow. Create a branch from the develop one, add commits, and open a pull request.

Please note we have a code of conduct, please follow it in all your interactions with the project.

If you want to get in touch with the author, you can contact me through LinkedIn or email.

Wish list

This is a small list of features/tools that I'll be very happy to have:

  • More database engines support.
  • More OOP languages support.
  • Syntax highlight for some text editors or IDEs (Sublime Text, Atom, IntelliJ IDEA, VS Code, ...).
  • XSD / JSON schema generation.
  • Liquibase files generation.
  • Any other cool stuff :stuck_out_tongue: