Skip to content

Commit 530609e

Browse files
authored
Merge pull request #37 from keliphan/readme
updated readme, gifs, testing
2 parents 3bb6b91 + 040566c commit 530609e

15 files changed

+93
-41
lines changed

README.md

Lines changed: 31 additions & 13 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>
@@ -12,7 +12,17 @@
1212

1313
![](https://raw.githubusercontent.com/jeisele2/OverVue/master/src/assets/gifs/screenshot.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,7 +59,9 @@
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.
5367
![](https://raw.githubusercontent.com/jeisele2/OverVue/master/src/assets/gifs/upload-image-drawers.gif)
@@ -89,7 +103,9 @@ 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.
94110

95111
+ You can nest html elements in two different ways:
@@ -104,13 +120,9 @@ package.json
104120
+ Setting layers on a component is done by right clicking the desired component on the component display and using the menu option
105121
All components start on layer 1 by default.
106122

123+
[↥Back to top](#table-of-contents)
107124

108-
109-
110-
111-
112-
113-
#### Running a local version
125+
### Running a local version
114126
This app was developed using the Quasar framework, so first you will need to install the Quasar cli
115127
```
116128
npm i -g @quasar/cli
@@ -128,7 +140,9 @@ To build a new .dmg / windows .exe
128140
quasar build -m electron
129141
```
130142

131-
#### Contributing
143+
[↥Back to top](#table-of-contents)
144+
145+
### Contributing
132146
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.
133147
Here are some features we're thinking about adding:
134148
+ Vuex state prototyping and boilerplate export
@@ -137,7 +151,9 @@ Here are some features we're thinking about adding:
137151
+ Integration with Storybook
138152
+ Ability to add a copy of an existing component from one route to another
139153

140-
#### Authors
154+
[↥Back to top](#table-of-contents)
155+
156+
### Authors
141157
```
142158
Contributors:
143159
Joseph Eisele @jeisele2
@@ -150,3 +166,5 @@ Allison Pratt @allisons11
150166
Joju Olaode @JojuOlaode
151167
```
152168
Inspired by [PreVue](https://github.com/open-source-labs/PreVue)
169+
170+
[↥Back to top](#table-of-contents)

package.json

Lines changed: 6 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",

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

src/assets/readme/nesting_html.gif

906 KB
Loading

src/assets/readme/overvue1.png

1.65 MB
Loading

0 commit comments

Comments
 (0)