Skip to content

Commit 735d523

Browse files
authored
Merge pull request #2 from oslabs-beta/chris/readme
Chris/readme
2 parents 5a5d028 + 4b34357 commit 735d523

File tree

4 files changed

+69
-15
lines changed

4 files changed

+69
-15
lines changed

README.md

Lines changed: 59 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,15 @@
6060
- Adding notes functionality <sub><sup>(v6.0)</sup></sub>
6161
- Enhanced component tree hierarchy display <sub><sup>(v6.0)</sup></sub>
6262
- 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>
63+
- Added color customization of components <sub><sup>(v7.0)</sup></sub>
6464
- More attribute options, class and v-model <sub><sup>(v7.0)</sup></sub>
6565
- Added scoped style tags for components <sub><sup>(v7.0)</sup></sub>
6666
- Size and position specification of HTML elements <sub><sup>(v7.0)</sup></sub>
67-
<br>
67+
- Added component snap to grid functionality <sub><sup>(v8.0)</sup></sub>
68+
- Ability to import vue component from Element Plus component library <sub><sup>(v8.0)</sup></sub>
69+
- Child component grid area CSS styling <sub><sup>(v8.0)</sup></sub>
70+
- Export project component hierarchy and enhanced boilerplate code <sub><sup>(v8.0)</sup></sub>
71+
6872
[↥Back to top](#table-of-contents)
6973

7074
### Changelog 2.0
@@ -188,8 +192,26 @@
188192
<h4><strong>Bug Fixes</strong></h4>
189193
<li>Fixed undo and redo capabilities </li>
190194
<li>Fixed badge number not rendering for nested HTML tags</li>
191-
<li></li>
195+
</ul>
196+
</details>
192197

198+
### Changelog 8.0
199+
200+
<details><summary>OverVue 8.0</summary>
201+
<ul>
202+
<li>Added component snap to grid functionality </li>
203+
<li>Code snippet reflects CSS grid area styling of components </li>
204+
<li>Ability to import components from Element Plus library</li>
205+
<li>Exported project template code now more accurately reflects component placement in app</li>
206+
<li>Improved canvas drag and deselect</li>
207+
<li>Improved WSL developer installation instructions</li>
208+
<br>
209+
<h4><strong>Bug Fixes</strong></h4>
210+
<li>Fixed routing components in project exports </li>
211+
<li>Fixed component hierarchy in project exports </li>
212+
<li>Fixed import statements of route child components</li>
213+
<li>Fixed edge case HTML element bugs in project exports </li>
214+
<li>Fixed in app component movement bugs which caused position to not update correctly </li>
193215
</ul>
194216
</details>
195217
<br/>
@@ -278,8 +300,19 @@ npm run build
278300
**The ability to load the application and/or devtools requires a tool/application to run a linux display as WSL does not have any display drivers since it is based off of just a CLI.
279301
I recommend X410 (https://x410.dev/), althought it does cost \$15, for ease of use. There are free options such as VcXsrv(https://sourceforge.net/projects/vcxsrv/) that you can get, but requires more set up.**
280302

303+
If you choose to use VcXsrv, you will need to select a couple options:
304+
305+
<ul>
306+
<li>Launch XLaunch</li>
307+
<li>Select multiple windows and display number=0.</li>
308+
<li>Select no client.</li>
309+
<li>Select Clipboard, Primary Selection, Native opengl, and disable access control.</li>
310+
<li>If Windows firewall pops up - select Public for this server to work.</li>
311+
</ul>
312+
281313
If you choose to use x410, you will need to set the environment DISPLAY variable on each console:
282314

315+
283316
So, to open either the Vue devtools or OverVue in dev mode, first start your X Server then enter into the terminal:
284317
For WSL 1 :
285318

@@ -293,19 +326,34 @@ For WSL 2 :
293326
export DISPLAY=$(awk '/nameserver / {print $2; exit}' /etc/resolv.conf 2>/dev/null):0
294327
export LIBGL_ALWAYS_INDIRECT=1
295328
```
329+
Then run the following command to run both OverVue and Vue developer tools.
330+
```
331+
npm run dev
332+
```
296333

297-
followed by the command for the s or devmode. If you want both open, enter commands above followed by starting the devtools:
334+
To launch the Vue devloper tool, use the following command.
298335

299336
```
300337
./node_modules/.bin/vue-devtools
301338
```
302339

303-
Then open a new terminal instance, set the DISPLAY value again (re-enter above command for DISPLAY), and start OverVue in dev mode:
340+
Then to start only OverVue in developer mode, open a new terminal instance and set the DISPLAY value again (re-enter above command for DISPLAY):
304341

305342
```
306343
quasar dev -m electron
307344
```
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.
345+
**NOTE**:
346+
<ul>
347+
<li>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.</li>
348+
<li>There might be an npm install error despite all instructions. Try the following command below:</li>
349+
</ul>
350+
351+
```
352+
sudo apt install libgconf-2-4 libatk1.0-0 libatk-bridge2.0-0 libgdk-pixbuf2.0-0 libgtk-3-0 libgbm-dev libnss3-dev libxss-dev
353+
```
354+
355+
356+
309357

310358
## Running the Docker Image
311359

@@ -423,7 +471,6 @@ Here are some features we're thinking about adding:
423471

424472

425473
- Ability to place child components into HTML elements
426-
- More semantic HTML tag options
427474
- Ability to export Vuex store boilerplate
428475
- Ability to add two-way binding to input elements
429476
- More granular typing options for TypeScript mode
@@ -468,10 +515,14 @@ Johnny Chan @jchan444
468515
Jace Crowe @JaceCrowe
469516
Keyla Koizumi Nishimura @keylakoizumin
470517
Katherine Kim @katherinek123
518+
Chris Wong @Koregano73
519+
Honghao(Michael) Sun @sunhonghaoparis
520+
Alex Law @alexlaw528
521+
Emma Genesen @EGenesen
471522
```
472523

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

475526
<br/>
476527

477-
[↥Back to top](#table-of-contents)
528+
[↥Back to top](#table-of-contents)

src/components/composables/useCreateComponent.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export function useCreateComponent(importObj) {
5050
htmlAttributes: {
5151
class: "",
5252
id: "",
53-
gridArea: [0, 2, 0, 2],
53+
gridArea: [0, 0, 2, 2],
5454
},
5555
};
5656

src/components/nav-buttons/ExportMenu.vue

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -248,12 +248,14 @@ export default {
248248
let str = "";
249249
let routeStr = "";
250250
251+
// Creates router-link boilerplate for App
251252
if (componentName === "App") {
252253
str += `<div id="app">\n\t\t<div id="nav">\n`;
253254
for(let route in routes) {
254255
if (route === "HomeView") {
255256
str += `\t\t\t<router-link to="/" class = "componentLinks">${route}</router-link>\n`;
256-
} else {
257+
}
258+
else {
257259
str += `\t\t\t<router-link to="/${route}" class = "componentLinks">${route}</router-link>\n`;
258260
}}
259261
str += `\t\t</div>\n\t\t<router-view class = "router-view"></router-view>\n`;

src/store/mutations.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -778,11 +778,12 @@ const mutations = {
778778
// update CSS grid grid area fr [Y beginning, Y end + 1, x beginning, x end + 1]
779779
if (updatedComponent.w === undefined) { updatedComponent.w = (2 * state.containerW / state.gridLayout[0]); }
780780
if (updatedComponent.h === undefined) { updatedComponent.h = (2 * state.containerH / state.gridLayout[1]); }
781-
const rowStart = Math.round(state.gridLayout[0] * updatedComponent.x / state.containerW) ;
782-
const rowEnd = Math.round(state.gridLayout[0] * (updatedComponent.x + updatedComponent.w) / state.containerW);
783-
const colStart = Math.round(state.gridLayout[1] * updatedComponent.y / state.containerH);
784-
const colEnd = Math.round(state.gridLayout[1] * (updatedComponent.y + updatedComponent.h) / state.containerH);
785-
updatedComponent.htmlAttributes.gridArea = [rowStart, rowEnd, colStart, colEnd];
781+
// add one - CSS grid-area is one-indexed
782+
const rowStart = 1 + Math.round(state.gridLayout[0] * updatedComponent.x / state.containerW) ;
783+
const colStart = 1 + Math.round(state.gridLayout[1] * updatedComponent.y / state.containerH);
784+
const rowEnd = 1 + Math.round(state.gridLayout[0] * (updatedComponent.x + updatedComponent.w) / state.containerW);
785+
const colEnd = 1 + Math.round(state.gridLayout[1] * (updatedComponent.y + updatedComponent.h) / state.containerH);
786+
updatedComponent.htmlAttributes.gridArea = [rowStart, colStart, rowEnd, colEnd];
786787
console.log('this is the grid area', updatedComponent.htmlAttributes.gridArea);
787788
},
788789

0 commit comments

Comments
 (0)