Skip to content

Commit 3b162b0

Browse files
authored
Merge pull request #163 from oslabs-beta/dev
Launch PR
2 parents 0ba9f1f + 981713f commit 3b162b0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+11650
-6540
lines changed

README.md

Lines changed: 45 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
- [Changelog 4.0](#changelog-40)
2020
- [Changelog 5.0](#changelog-50)
2121
- [Changelog 6.0](#changelog-60)
22+
- [Changelog 7.0](#changelog-70)
2223
- [How to use](#how-to-use)
2324
- [Installation](#installation)
2425
- [WSL Installation](#wsl-installation)
@@ -28,7 +29,7 @@
2829
- [Contributing](#contributing)
2930
- [Authors](#authors)
3031

31-
### Features
32+
### Feature Log
3233

3334
- Upload a frontend mockup image
3435
- Visualize draggable and resizable components
@@ -58,7 +59,12 @@
5859
- Introduced TypeScript Mode <sub><sup>(v6.0)</sup></sub>
5960
- Adding notes functionality <sub><sup>(v6.0)</sup></sub>
6061
- Enhanced component tree hierarchy display <sub><sup>(v6.0)</sup></sub>
61-
62+
- Added drag and drop of HTML elements <sub><sup>(v7.0)</sup></sub>
63+
- Added color customization of compoents <sub><sup>(v7.0)</sup></sub>
64+
- More attribute options, class and v-model <sub><sup>(v7.0)</sup></sub>
65+
- Added scoped style tags for components <sub><sup>(v7.0)</sup></sub>
66+
- Size and position specification of HTML elements <sub><sup>(v7.0)</sup></sub>
67+
<br>
6268
[↥Back to top](#table-of-contents)
6369

6470
### Changelog 2.0
@@ -164,25 +170,42 @@
164170
<li>Fixed project tree visulization</li>
165171
</ul>
166172
</details>
173+
174+
### Changelog 7.0
175+
176+
<details><summary>OverVue 7.0</summary>
177+
<ul>
178+
<li>Color customizability of components </li>
179+
<li>Code snippet reflects CSS styling of components </li>
180+
<li>Added more semantic HTML tags</li>
181+
<li>Options to add class, ID, and v-model attributes</li>
182+
<li>Added drag and drop feature when adding/altering HTML tags</li>
183+
<li>Ability to add child components to the code snippet of parent components </li>
184+
<li>Added scoped style tags - On class creation will create styling entry with positioning of component/html element</li>
185+
<li>Consolidated state/actions/props into one tab</li>
186+
<li>UI overhaul</li>
187+
<br>
188+
<h4><strong>Bug Fixes</strong></h4>
189+
<li>Fixed undo and redo capabilities </li>
190+
<li>Fixed badge number not rendering for nested HTML tags</li>
191+
<li></li>
192+
193+
</ul>
194+
</details>
167195
<br/>
168196

169197
[↥Back to top](#table-of-contents)
170198

171199
## How to use
172200

173-
- Upon opening the application a Connect to Slack button will appear. To skip this step click 'Skip'
174-
- Click the button to open a browser window, log in to your Slack workspace and select a channel to send save notifications.
175-
- If you have logged in to Slack, upon saving your project file you will receive a prompt with the option to notify your team.
176-
![](./src/assets/readme/v4Slack_Oauth.gif)
177-
178201
- OverVue will assign a default root App component and a default route called "HomeView"
179-
- Upload a mockup from your filesystem if you'd like. Remove the mockup and choose a new one if needed.
180-
![](./src/assets/readme/v4Upload_image.gif)
181202

182203
- 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.
183204
- HTML elements can also be added after creation by selecting the component in the display, then selecting HTML elements.
205+
- You may nest HTML elements by clicking the chevron and selecting the nested HTML elements. Return to the parent HTML element by clicking clicking the carrot above the HTML element.
206+
184207
- Select a parent component for the new component if needed.
185-
- After adding, you can move and resize the component in the display.
208+
- After creating the component, you can move, resize, and recolor the component in the display. For advanced styling options, double click on the desired HTML element to modify. Here, you may add attributes such as class, ID, and v-model.
186209
![](./src/assets/readme/v4Creating_Component.gif)
187210

188211
- You can also duplicate components with Ctrl/Cmd C & V and see the component tree updated in real time.
@@ -192,16 +215,16 @@
192215
- Child components will inherit the same parents, but parent components will not inherit duplicate children.
193216
![](./src/assets/readme/v4Copy_Parent_Component.gif)
194217

195-
- The right-side drawer displays live code snippets for the selected element.
218+
- The right-side, Component Details > Code Snippet Tab displays live code snippets for the selected component.
196219
![](./src/assets/readme/v4Code_Snippet.gif)
197220

198-
- You can view and add new routes and associated components in the left-hand drawer.
221+
- You can view and add new routes and associated components in the right-side, Routes Gab. The newly created routes will be visible in the Project Tree Tab.
199222
![](./src/assets/readme/v4Copying_Route.gif)
200223

201224
- State and actions can be created, edited, and assigned to components.
202225
![](./src/assets/readme/v4State_and_actions.gif)
203226

204-
- When finished creating, you can export to a file location of your choice. Below is the exported file structure:
227+
- When finished creating, view your code snippet under the code snippet tab and you can export to a file location of your choice. Below is the exported file structure:
205228

206229
```
207230
public/
@@ -230,13 +253,7 @@ package.json
230253

231254
## Installation
232255

233-
To download the development version for windows or mac, please visit https://www.Overvue.io
234-
235-
This app was developed using the Quasar framework, so first you will need to install the Quasar cli
236-
237-
```
238-
npm i -g @quasar/cli
239-
```
256+
To download the production version for windows or mac, please visit https://www.Overvue.io
240257

241258
Install dependencies
242259

@@ -247,13 +264,13 @@ npm i
247264
To run electron app in dev mode (note: Vue Devtools will launch automatically)
248265

249266
```
250-
quasar dev -m electron
267+
npm run dev
251268
```
252269

253270
To build a new .dmg / windows .exe
254271

255272
```
256-
quasar build -m electron
273+
npm run build
257274
```
258275

259276
### WSL Installation
@@ -288,6 +305,8 @@ Then open a new terminal instance, set the DISPLAY value again (re-enter above c
288305
```
289306
quasar dev -m electron
290307
```
308+
**NOTE** Electron-deeplink currently does not work on our WSL2 computers and output an error during installing the dependency which prevented the application to open in dev mode. Go to /src-electron/electron-main.js and comment out line 3/import line to bypass error. The developers did not find any impacts on application so far.
309+
291310
## Running the Docker Image
292311

293312
To run the built version, pull down the docker image from [Docker repo]
@@ -445,6 +464,10 @@ Bryan Bart @MrBeeAreWhy
445464
Julia Bakerink @jbbake
446465
Kerolos Nesem @Kerolos-Nesem
447466
Megan Nadkarni @megatera
467+
Johnny Chan @jchan444
468+
Jace Crowe @JaceCrowe
469+
Keyla Koizumi Nishimura @keylakoizumin
470+
Katherine Kim @katherinek123
448471
```
449472

450473
Inspired by [PreVue](https://github.com/open-source-labs/PreVue)

0 commit comments

Comments
 (0)