Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/r48n34/db-erd-gen
🗃️ Free DrawSQL like website
https://github.com/r48n34/db-erd-gen
knex kysely postgresql sql website
Last synced: 7 days ago
JSON representation
🗃️ Free DrawSQL like website
- Host: GitHub
- URL: https://github.com/r48n34/db-erd-gen
- Owner: r48n34
- License: mit
- Created: 2023-01-02T14:26:35.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-23T16:13:46.000Z (29 days ago)
- Last Synced: 2024-11-23T17:20:28.330Z (29 days ago)
- Topics: knex, kysely, postgresql, sql, website
- Language: TypeScript
- Homepage: https://db-erd-gen.vercel.app/home
- Size: 856 KB
- Stars: 24
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 💾 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.
```bash
git clone https://github.com/r48n34/db-erd-gen.git
```
2. Install packages with npm / yarn.
```bash
# Install with yarn for samples
yarn
```
3. Start the project with dev mode.
```bash
# Start with dev
yarn dev
```
4. Build the project.
```bash
# Build to production
yarn build
```
5. Preview the build project.
```bash
yarn preview
```
## 🐳 Self hosting (Docker)
1. Build the docker container with the following command.
```bash
docker build . -t db-erd-gen
```
2. After builded, run the container.
```bash
docker run -d -p 5174:5174 db-erd-gen:latest
```
## License
Distributed under the `MIT License`.