README.md

💾 db-erd-gen

✏️ Free DrawSQL like website but free forever

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
• mikro-orm (Todo)
• Mongoose Scheme (TBC)

🗺️ Roadmap

• ✅ With Zod type checking
• ✅ Update Maininte to v7
• ⬜️ i18n adapts
• ⬜️ mikro-orm & Mongoose Scheme adapts

📝 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
• ⬜️ 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

2. Install packages with npm / yarn.

# Install with yarn for samples
yarn

3. Start the project with dev mode.

# Start with dev
yarn dev

4. Build the project.

# Build to production
yarn build

5. Preview the build project.

yarn preview

🐳 Self hosting (Docker)

1. Build the docker container with the following command.

docker build . -t db-erd-gen

2. After builded, run the container.

docker run -d -p 5174:5174 db-erd-gen:latest

License

Distributed under the MIT License.