Skip to content

Commit 7d314dd

Browse files
committed
added reamde and workflows
1 parent 8aab182 commit 7d314dd

File tree

2 files changed

+109
-3
lines changed

2 files changed

+109
-3
lines changed

.github/workflows/deploy-demo.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Deploy Demo
2+
3+
on:
4+
push:
5+
branches: [master]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: write
10+
pages: write
11+
12+
jobs:
13+
build-and-deploy:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v3
18+
19+
- name: Setup Node.js
20+
uses: actions/setup-node@v3
21+
with:
22+
node-version: 20
23+
cache: 'yarn'
24+
25+
- name: Install dependencies
26+
run: yarn install
27+
28+
- name: Build demo
29+
run: yarn build
30+
31+
- name: Deploy to GitHub Pages
32+
uses: JamesIves/github-pages-deploy-action@v4
33+
with:
34+
folder: dist
35+
branch: gh-pages

README.md

Lines changed: 74 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,76 @@
1-
# Vue 3 + TypeScript + Vite
1+
<p align="center">
2+
<img src="https://raw.githubusercontent.com/ZiZiGY/vue-dnd-kit/master/public/logo.svg" width="400" alt="HTML Builder Logo">
3+
</p>
24

3-
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
5+
<h1 align="center">HTML Builder Component</h1>
46

5-
Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
7+
<p align="center">
8+
A powerful, visual HTML structure builder component for Vue 3 applications
9+
</p>
10+
11+
<p align="center">
12+
<img src="https://img.shields.io/badge/Framework-Vue%203-brightgreen" alt="Framework: Vue 3">
13+
<img src="https://img.shields.io/badge/Language-TypeScript-blue" alt="Language: TypeScript">
14+
<img src="https://img.shields.io/badge/Status-Beta-yellow" alt="Status: Beta">
15+
</p>
16+
17+
## ✨ About
18+
19+
HTML Builder is an advanced component that allows you to visually create and manipulate HTML structures through an intuitive interface. Despite being a single component, its functionality is so extensive that it has been developed in a dedicated repository.
20+
21+
## 🚀 Features
22+
23+
- **Visual HTML Construction**: Build complex HTML structures without writing code
24+
- **Drag & Drop Interface**: Easily arrange and organize elements
25+
- **Real-time Preview**: See your changes instantly
26+
- **Advanced Configuration**: Fine-tune element properties through a comprehensive settings panel
27+
- **Component-Based**: Works seamlessly with Vue 3 component architecture
28+
29+
## 📋 Component Structure
30+
31+
The HTML Builder component is organized into several sub-components:
32+
33+
- **HTMLBuilderArea**: Main workspace for visual editing
34+
- **HTMLBuilderConfig**: Configuration sidebar for element properties
35+
- **HTMLBuilderTree**: Hierarchical view of HTML structure
36+
- **HTMLBuilderDraggable/Droppable**: Drag and drop functionality components
37+
38+
## 🔧 Configuration Sections
39+
40+
The builder provides comprehensive configuration options for HTML elements:
41+
42+
- Dimensions
43+
- Margin & Padding
44+
- Border
45+
- Background
46+
- Display Properties
47+
- And more...
48+
49+
## 💻 Development
50+
51+
This project is built with Vue 3, TypeScript, and Vite. It uses the Vue 3 `<script setup>` SFCs for component authoring.
52+
53+
### Prerequisites
54+
55+
- Node.js 16+
56+
- Yarn or npm
57+
58+
### Setup
59+
60+
```bash
61+
# Install dependencies
62+
yarn install
63+
64+
# Start development server
65+
yarn dev
66+
```
67+
68+
For additional information about project setup and IDE support, refer to the [Vue TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
69+
70+
## 📄 License
71+
72+
[MIT](LICENSE)
73+
74+
---
75+
76+
<p align="center">Made with ❤️ by <a href="https://github.com/zizigy">ZiZiGY</a></p>

0 commit comments

Comments
 (0)