Skip to content

Commit d9493cc

Browse files
merged json changes into beta repo
2 parents 5458567 + 835023c commit d9493cc

19 files changed

+128
-65
lines changed

README.md

Lines changed: 40 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<h1 align="center">
22
<img src="https://raw.githubusercontent.com/jeisele2/OverVue/master/src/assets/overvue-icons/apple-icon-72x72.png">
33
<br/>
4-
OverVue (Beta)
4+
OverVue
55
</h1>
66

77
<p align="center"><b>Prototyping Tool for Vue Developers</b></p>
@@ -10,9 +10,19 @@
1010

1111
<p>这个程序能帮你生成Vue 组件, 设置 routes , 也可以帮你显像Component Parent-Child组件树。你只要做一些小配置然后可以下载code boilerplate. 这样你就可以很方便简洁地生成Vue前台APP了!</p>
1212

13-
![](https://raw.githubusercontent.com/jeisele2/OverVue/master/src/assets/gifs/screenshot.png)
13+
![](./src/assets/readme/overvue1.png)
1414

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
1626
+ Upload a frontend mockup image
1727
+ Visualize draggable and resizable components
1828
+ Create parent-child hierarchy of components
@@ -30,7 +40,9 @@
3040
+ Will now load route images along with project <sub><sup>(v2.0)</sup></sub>
3141
+ Windows compatibility for uploading mockup images. <sub><sup>(v2.0)</sup></sub>
3242

33-
#### Changelog
43+
[↥Back to top](#table-of-contents)
44+
45+
### Changelog
3446
<details><summary>OverVue 2.0</summary>
3547
<ul>
3648
<li>Improved hierarchy tree rendering</li>
@@ -47,25 +59,27 @@
4759
</ul>
4860
</details>
4961

50-
#### How to use
62+
[↥Back to top](#table-of-contents)
63+
64+
## How to use
5165
+ Opening the application will create by default a root App component and a root route called "HomeView"
5266
+ 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)
5468

5569
+ 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.
5670
+ HTML elements can also be added after creation by selecting the component in the display, then selecting HTML elements.
5771
+ Select a parent component for the new component if needed.
5872
+ 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)
6074

6175
+ 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)
6377

6478
+ 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)
6680

6781
+ 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)
6983

7084
+ When finished creating, you can export to a file location of your choice. Below is the exported file structure:
7185

@@ -89,8 +103,11 @@ src/
89103
babel.config.js
90104
package.json
91105
```
92-
###### OverVue v2.0 How to
106+
[↥Back to top](#table-of-contents)
107+
108+
### OverVue v2.0 How to
93109
+ 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)
94111

95112
+ You can nest html elements in two different ways:
96113
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
100117
2. Similar to above, but instead of double clicking, you can press the down arrow icon on the html element button to enter it.
101118
From there the view will change to the contents of that particular HTML element.
102119
You can then add html elements like you would for a component using the left hand side
120+
![](./src/assets/readme/nesting_html.gif)
103121

104122
+ Setting layers on a component is done by right clicking the desired component on the component display and using the menu option
105123
All components start on layer 1 by default.
124+
![](./src/assets/readme/layers.gif)
106125

126+
[↥Back to top](#table-of-contents)
107127

108-
109-
110-
111-
112-
113-
#### Running a local version
128+
### Running a local version
114129
This app was developed using the Quasar framework, so first you will need to install the Quasar cli
115130
```
116131
npm i -g @quasar/cli
@@ -128,7 +143,9 @@ To build a new .dmg / windows .exe
128143
quasar build -m electron
129144
```
130145

131-
#### Contributing
146+
[↥Back to top](#table-of-contents)
147+
148+
### Contributing
132149
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.
133150
Here are some features we're thinking about adding:
134151
+ Vuex state prototyping and boilerplate export
@@ -137,7 +154,9 @@ Here are some features we're thinking about adding:
137154
+ Integration with Storybook
138155
+ Ability to add a copy of an existing component from one route to another
139156

140-
#### Authors
157+
[↥Back to top](#table-of-contents)
158+
159+
### Authors
141160
```
142161
Contributors:
143162
Joseph Eisele @jeisele2
@@ -150,3 +169,5 @@ Allison Pratt @allisons11
150169
Joju Olaode @JojuOlaode
151170
```
152171
Inspired by [PreVue](https://github.com/open-source-labs/PreVue)
172+
173+
[↥Back to top](#table-of-contents)

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
{
22
"name": "overvue",
3-
"version": "0.0.1",
3+
"version": "2.0.0",
44
"description": "Vue Prototype DevTool",
55
"productName": "OverVue",
66
"cordovaId": "org.cordova.quasar.app",
7-
"author": "Team OverVue",
7+
"author": "Team OverVue, Team Vuetiful",
88
"private": true,
9+
"bugs": {
10+
"url": "https://github.com/TeamOverVue/OverVue/issues"
11+
},
12+
"homepage": "https://github.com/TeamOverVue/OverVue",
913
"scripts": {
1014
"lint": "eslint --ext .js,.vue src",
1115
"test": "echo \"See package.json => scripts for available tests.\" && exit 0",
@@ -21,14 +25,25 @@
2125
"aws-amplify": "^1.1.30",
2226
"aws-amplify-vue": "^0.2.13",
2327
"aws-appsync": "^1.8.1",
28+
"dot-prop": "^6.0.0",
2429
"fs-extra": "^8.1.0",
2530
"localforage": "^1.7.3",
31+
<<<<<<< HEAD
2632
"lodash": "^4.17.21",
2733
"lodash.isequal": "^4.5.0",
2834
"lodash.throttle": "^4.1.1",
2935
"mousetrap": "^1.6.3",
3036
"npm": "^6.14.14",
3137
"prismjs": "^1.24.1",
38+
=======
39+
"lodash": ">=4.17.19",
40+
"lodash.isequal": "^4.5.0",
41+
"lodash.throttle": "^4.1.1",
42+
"mousetrap": "^1.6.3",
43+
"node-forge": "^0.10.0",
44+
"npm": "^6.14.5",
45+
"prismjs": "^1.16.0",
46+
>>>>>>> 835023cad4c4adea81c05464317c052a0a8931d2
3247
"quasar": "^1.0.0",
3348
"vue-custom-context-menu": "^3.0.1",
3449
"vue-drag-resize": "^1.3.2",
@@ -48,8 +63,13 @@
4863
"@vue/eslint-config-standard": "^4.0.0",
4964
"babel-eslint": "^10.0.1",
5065
"devtron": "^1.4.0",
66+
<<<<<<< HEAD
5167
"electron": "^5.0.6",
5268
"electron-builder": "^22.11.10",
69+
=======
70+
"electron": "^7.2.4",
71+
"electron-builder": "^22.7.0",
72+
>>>>>>> 835023cad4c4adea81c05464317c052a0a8931d2
5373
"electron-debug": "^3.0.1",
5474
"electron-devtools-installer": "^2.2.4",
5575
"eslint": "^5.10.0",

src-electron/icons/icon.ico

-90.9 KB
Binary file not shown.
18.9 KB
Loading

src/assets/readme/add_new_route.gif

830 KB
Loading
702 KB
Loading

src/assets/readme/dashboard.gif

1020 KB
Loading

src/assets/readme/layers.gif

734 KB
Loading
158 KB
Loading

0 commit comments

Comments
 (0)