https://github.com/seakmengs/yato-erd
A web-based Entity-Relationship Diagram design tool.
https://github.com/seakmengs/yato-erd
erd nuxt shadcn-ui typescript vue vueflow zod
Last synced: 2 months ago
JSON representation
A web-based Entity-Relationship Diagram design tool.
- Host: GitHub
- URL: https://github.com/seakmengs/yato-erd
- Owner: SeakMengs
- Created: 2024-08-20T10:10:06.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-11-05T14:30:55.000Z (6 months ago)
- Last Synced: 2025-02-13T02:47:38.548Z (2 months ago)
- Topics: erd, nuxt, shadcn-ui, typescript, vue, vueflow, zod
- Language: Vue
- Homepage: https://yatoerd.netlify.app
- Size: 411 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ✨ YatoERD
YatoERD is a web-based Entity-Relationship Diagram design tool.
## ✨ Preview
## ✨ Roadmap
- [x] Add table, edit table
- [x] Auto layout
- [x] Export as JSON, PNG, JPEG, SVG
- [x] Dark/Light mode
- [x] Drag and drop table columns to reorder
- [ ] Export as MySQL, PostgreSQL file
- [ ] Access diagram online (e.g., from Google Drive)
- [ ] Support multilingual
## ✨ Setup
Make sure to have node js and install the dependencies:
```bash
npm install
```
## ✨ Development
To run the development server:
```bash
npm run dev
```
If you prefer to use docker for development, you can use the following command:
```bash
docker-compose up
```
## ✨ Production
To build the project:
```bash
npm run build
node .output/server/index.mjs
```
If you prefer to use docker for production, you can use the following command:
```bash
docker-compose -f docker-compose.prod.yml up
```
## ✨ Hosting
YatoERD is simple to host, and you can use hosting services like Vercel, Netlify to deploy without any problem. However, if you prefer to host it on your server, you can use the following command:
```bash
git clone https://github.com/SeakMengs/yato-erd
cd yato-erd
docker-compose -f docker-compose.prod.yml up
```
## ✨ Testing
To perform unit test run the following command:
```bash
npm run test
```
## ✨ Contribute
- Feel free to open an issue or pull request if you have any idea or found any bug
- If you want to support me, you can [buy me a coffee](https://www.buymeacoffee.com/seakmeng)
## ✨ Inspiration
- Excalidraw
- DrawSQL
- Draw.io