Skip to content

r48n34/db-erd-gen

Repository files navigation

πŸ’Ύ db-erd-gen

✏️ Free DrawSQL like website but free forever

https://db-erd-gen.vercel.app/

URL: https://db-erd-gen.vercel.app/

πŸ’‘ Features

  1. Free forever and open sources.
  2. Save SQL in various DB format.
  3. Easy to use / store GUI website.
  4. Low learning curve UI.
  5. No server involved, all in local.

πŸ”Š Current supported output

  • Postgres raw
  • MySQL / MariaDB raw
  • SQLite raw
  • knex.js
  • kysely ts types
  • kysely Postgres
  • kysely sqlite
  • Typescript types
  • Zod scheme types
  • Yup scheme types
  • Valibot scheme types
  • Prisma Postgres
  • Prisma MySQL
  • Drizzle ORM (Postgres)
  • Drizzle ORM (MySQL)
  • Drizzle ORM (sqlite)
  • Sequelize (Postgres, MySQL, sqlite) (Thanks roshangautam07)
  • Mongoose Scheme (TBC)

πŸ—ΊοΈ Roadmap

  • βœ… With Zod type checking
  • βœ… Update Maininte to v7
  • βœ… Drizzle ORM Support
  • ⬜️ i18n adapts
  • ⬜️ Allow to dup table

πŸ“ Todo

  • βœ… Support kysely db migrate types output
  • βœ… Support kysely ts types output
  • βœ… Support SQLite types output
  • βœ… Support MySQL / MariaDB types output
  • βœ… Support typescript normal types
  • βœ… Support zod types generate
  • βœ… Support Tables CRUD code for several frameworks
  • βœ… Support Drizzle ORM types output
  • ⬜️ Add enums options and input for enums
  • ⬜️ Support defaultTo string in general
  • ⬜️ Support defaultTo string in kysely
  • βœ… Support Prisma types output
  • βœ… Add UNIQUE types
  • βœ… Support sqlite types output
  • ⬜️ More features
  • βœ… Update UI
  • ⬜️ Testing vitest

🏠 Self hosting (Nodejs base)

  1. Clone the project to your environment.
git clone https://github.com/r48n34/db-erd-gen.git
  1. Install packages with npm / yarn.
# Install with yarn for samples
yarn
  1. Start the project with dev mode.
# Start with dev
yarn dev
  1. Build the project.
# Build to production
yarn build
  1. Preview the build project.
yarn preview

🐳 Self hosting (Docker)

  1. Build the docker container with the following command.
docker build . -t db-erd-gen
  1. After builded, run the container.
docker run -d -p 5174:5174 db-erd-gen:latest

πŸš— License

Distributed under the MIT License.

About

πŸ—ƒοΈ Free DrawSQL like website

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages