1
1
<h1 align =" center " >
2
2
<img src =" https://raw.githubusercontent.com/jeisele2/OverVue/master/src/assets/overvue-icons/apple-icon-72x72.png " >
3
3
<br />
4
- OverVue (Beta)
4
+ OverVue
5
5
</h1 >
6
6
7
7
<p align =" center " ><b >Prototyping Tool for Vue Developers</b ></p >
10
10
11
11
<p >这个程序能帮你生成Vue 组件, 设置 routes , 也可以帮你显像Component Parent-Child组件树。你只要做一些小配置然后可以下载code boilerplate. 这样你就可以很方便简洁地生成Vue前台APP了!</p >
12
12
13
- ![ ] ( https://raw.githubusercontent.com/jeisele2/OverVue/master/ src/assets/gifs/screenshot .png)
13
+ ![ ] ( ./ src/assets/readme/overvue1 .png)
14
14
15
- #### Features
15
+ ## Table of Contents
16
+
17
+ * [ Features] ( #features )
18
+ * [ OverVue 2.0 Changelog] ( #changelog )
19
+ * [ Tutorial] ( #how-to-use )
20
+ + [ New Features Tutorial] ( #overvue-v20-how-to )
21
+ * [ How to Run] ( #running-a-local-version )
22
+ * [ Contributing] ( #contributing )
23
+ * [ Authors] ( #authors )
24
+
25
+ ### Features
16
26
+ Upload a frontend mockup image
17
27
+ Visualize draggable and resizable components
18
28
+ Create parent-child hierarchy of components
30
40
+ Will now load route images along with project <sub ><sup >(v2.0)</sup ></sub >
31
41
+ Windows compatibility for uploading mockup images. <sub ><sup >(v2.0)</sup ></sub >
32
42
33
- #### Changelog
43
+ [ ↥Back to top] ( #table-of-contents )
44
+
45
+ ### Changelog
34
46
<details ><summary >OverVue 2.0</summary >
35
47
<ul >
36
48
<li >Improved hierarchy tree rendering</li >
47
59
</ul >
48
60
</details >
49
61
50
- #### How to use
62
+ [ ↥Back to top] ( #table-of-contents )
63
+
64
+ ## How to use
51
65
+ Opening the application will create by default a root App component and a root route called "HomeView"
52
66
+ Upload a mockup from your filesystem if you'd like. Remove the mockup and choose a new one if needed.
53
- ![ ] ( https://raw.githubusercontent.com/jeisele2/OverVue/master/ src/assets/gifs/upload-image-drawers .gif)
67
+ ![ ] ( ./ src/assets/readme/upload_one_mockup .gif)
54
68
55
69
+ To add a new component, type its name in the component name box and select any HTML elements that should be rendered by that component.
56
70
+ HTML elements can also be added after creation by selecting the component in the display, then selecting HTML elements.
57
71
+ Select a parent component for the new component if needed.
58
72
+ After adding, you can move and resize the component in the display.
59
- ![ alt text] ( https://raw.githubusercontent.com/jeisele2/OverVue/master/ src/assets/gifs/component_creation .gif)
73
+ ![ alt text] ( ./ src/assets/readme/create_resize_move .gif)
60
74
61
75
+ You can also add children to components by right-clicking the component to add children to, and you can see the tree re-render as you create new components or change the hierarchy.
62
- ![ ] ( https://raw.githubusercontent.com/jeisele2/OverVue/master/ src/assets/gifs/HTML-elements-tree-rerender .gif)
76
+ ![ ] ( ./ src/assets/readme/right_click_add_children .gif)
63
77
64
78
+ The dashboard shows info about each component (code snippets and HTML elements). Click a component in the display to see its properties.
65
- ![ ] ( https://raw.githubusercontent.com/jeisele2/OverVue/master/ src/assets/gifs/snippets-active-component .gif)
79
+ ![ ] ( ./ src/assets/readme/dashboard .gif)
66
80
67
81
+ You can add new routes and view all components and routes in the sidebar.
68
- ![ ] ( https://raw.githubusercontent.com/jeisele2/OverVue/master/ src/assets/gifs/sidebar-components-routes .gif)
82
+ ![ ] ( ./ src/assets/readme/add_new_route .gif)
69
83
70
84
+ When finished creating, you can export to a file location of your choice. Below is the exported file structure:
71
85
89
103
babel.config.js
90
104
package.json
91
105
```
92
- ###### OverVue v2.0 How to
106
+ [ ↥Back to top] ( #table-of-contents )
107
+
108
+ ### OverVue v2.0 How to
93
109
+ Undo/Redo feature has been added to the top right of the program, you can also use CTRL+z and CTRL+y respectively.
110
+ ![ ] ( ./src/assets/readme/undo_redo.gif )
94
111
95
112
+ You can nest html elements in two different ways:
96
113
1 . Upon creating a component and adding an html element into it, Select the component to make it the active component.
@@ -100,17 +117,15 @@ package.json
100
117
2 . Similar to above, but instead of double clicking, you can press the down arrow icon on the html element button to enter it.
101
118
From there the view will change to the contents of that particular HTML element.
102
119
You can then add html elements like you would for a component using the left hand side
120
+ ![ ] ( ./src/assets/readme/nesting_html.gif )
103
121
104
122
+ Setting layers on a component is done by right clicking the desired component on the component display and using the menu option
105
123
All components start on layer 1 by default.
124
+ ![ ] ( ./src/assets/readme/layers.gif )
106
125
126
+ [ ↥Back to top] ( #table-of-contents )
107
127
108
-
109
-
110
-
111
-
112
-
113
- #### Running a local version
128
+ ### Running a local version
114
129
This app was developed using the Quasar framework, so first you will need to install the Quasar cli
115
130
```
116
131
npm i -g @quasar/cli
@@ -128,7 +143,9 @@ To build a new .dmg / windows .exe
128
143
quasar build -m electron
129
144
```
130
145
131
- #### Contributing
146
+ [ ↥Back to top] ( #table-of-contents )
147
+
148
+ ### Contributing
132
149
We'd love for you to test this application out and submit any issues you encounter. Also feel free to fork to your own repo and submit PRs.
133
150
Here are some features we're thinking about adding:
134
151
+ Vuex state prototyping and boilerplate export
@@ -137,7 +154,9 @@ Here are some features we're thinking about adding:
137
154
+ Integration with Storybook
138
155
+ Ability to add a copy of an existing component from one route to another
139
156
140
- #### Authors
157
+ [ ↥Back to top] ( #table-of-contents )
158
+
159
+ ### Authors
141
160
```
142
161
Contributors:
143
162
Joseph Eisele @jeisele2
@@ -150,3 +169,5 @@ Allison Pratt @allisons11
150
169
Joju Olaode @JojuOlaode
151
170
```
152
171
Inspired by [ PreVue] ( https://github.com/open-source-labs/PreVue )
172
+
173
+ [ ↥Back to top] ( #table-of-contents )
0 commit comments