Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maks-kovpak/db-craft
DB Craft is a web application designed to simplify the creation of database diagrams
https://github.com/maks-kovpak/db-craft
konva-react next typescript
Last synced: 2 days ago
JSON representation
DB Craft is a web application designed to simplify the creation of database diagrams
- Host: GitHub
- URL: https://github.com/maks-kovpak/db-craft
- Owner: maks-kovpak
- License: mit
- Created: 2024-09-07T17:47:44.000Z (26 days ago)
- Default Branch: main
- Last Pushed: 2024-09-29T09:28:42.000Z (4 days ago)
- Last Synced: 2024-09-29T12:40:57.055Z (4 days ago)
- Topics: konva-react, next, typescript
- Language: TypeScript
- Homepage:
- Size: 256 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DB Craft
DB Craft is a web application designed to simplify the creation of database diagrams. Built using
Next.js and TypeScript, DB Craft offers an intuitive interface for developers and database
architects to visualize and design their database schemas.
## Features
- **Interactive Diagram Creation**: Drag and drop tables, columns, and relationships to design your
database schema.
- **Export Options**: Export diagrams as SQL, JSON, or PNG for easy integration and sharing.
- **Integration**: Connect with databases like PostgreSQL and MySQL for schema import/export.
- **Responsive Design**: Optimized for desktop and mobile for seamless designing on the go.
## Getting Started
### Prerequisites
Before you begin, ensure you have the following installed:
- Node.js (>= 18.x)
- Yarn
- PostgreSQL (optional for local development)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/maks-kovpak/db-craft.git
```
2. Navigate to the project directory:
```bash
cd db-craft
```
3. Install dependencies:
```bash
yarn install
```
4. Set up environment variables:
Create a `.env.local` file in the root directory and add necessary environment variables (e.g.,
database connection strings, API keys).
5. Run the development server:
```bash
yarn dev
```
6. Open [http://localhost:3000](http://localhost:3000) in your browser to see the app.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.