Skip to content

Commit 4bfe2a7

Browse files
committed
populated get started content; updated readme with docker for mac instructions;styling updates
1 parent 083860d commit 4bfe2a7

30 files changed

+172
-78
lines changed

README.md

Lines changed: 78 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
- [How to use](#how-to-use)
2323
- [Installation](#installation)
2424
- [WSL Installation](#wsl-installation)
25-
- [Running as Containerized Docker Image](#running-as-containerized-docker-image)
25+
- [Running the Docker Image](#running-the-docker-image)
2626
- [BETA](#beta)
2727
- [Slack OAuth](#slack-oauth)
2828
- [Contributing](#contributing)
@@ -212,14 +212,15 @@ src/
212212
UserCreatedComponent1.vue
213213
UserCreatedComponent2.vue
214214
...
215+
router/
216+
index.js
215217
views/
216218
HomeView.vue
217219
UserCreatedRouteComponent1.vue
218220
UserCreatedRouteComponent2.vue
219221
...
220222
App.vue
221223
main.js
222-
router.js
223224
babel.config.js
224225
package.json
225226
```
@@ -287,13 +288,84 @@ Then open a new terminal instance, set the DISPLAY value again (re-enter above c
287288
```
288289
quasar dev -m electron
289290
```
290-
### Running as Containerized Docker Image
291+
## Running the Docker Image
291292

292-
In your terminal, run :
293+
To run the built version, pull down the docker image from [Docker repo]
293294

295+
In your terminal, run:
296+
297+
```
298+
docker run -v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=$DISPLAY -v`pwd`/src:/app/src --rm -it overvue
299+
```
300+
### Running the dev environment on Docker as a Mac User
301+
To run OverVue through Docker on a Mac, you'll need to install XQuartz:
302+
```
303+
brew install --cask xquartz
304+
```
305+
306+
<strong>Important:</strong> RESTART your computer.
307+
308+
Update your PATH variable to /opt/x11/bin to your .zshrc. For example:
309+
```
310+
export PATH=/opt/X11/bin:$PATH
311+
```
312+
313+
Set up XQuartz:
314+
<ul>
315+
<li>Launch XQuartz</li>
316+
<li>Under the XQuartz menu, select Preferences.</li>
317+
<li>Go to the security tab and ensure "Allow connections from network clients" is checked.</li>
318+
<li>Restart XQuartz</li>
319+
</ul>
320+
321+
Run the following command in your terminal (replacing localhostname with your local host name)
322+
```
323+
xhost +localhostname
324+
```
325+
If you don't know your local host name, run the following command to find it:
326+
```
327+
echo $(hostname)
328+
```
329+
330+
Build the image using Dockerfile-Mac:
331+
```
332+
docker build -t overvue -f Dockerfile-Mac .
333+
```
334+
335+
Run the image using the following command
336+
```
337+
docker run -it --env="DISPLAY=$(ifconfig en0 | grep inet | awk '$1=="inet" {print$2}'):0" --security-opt seccomp=./chrome.json overvue
338+
```
339+
340+
Run in dev mode using:
341+
```
342+
npm run dev
343+
```
344+
345+
For more information about running Electron through Docker on a Mac, check out these posts:
346+
<li><a href="https://jaked.org/blog/2021-02-18-How-to-run-Electron-on-Linux-on-Docker-on-Mac">How to run Electron on Linux on Docker on Mac</a></li>
347+
<li><a href="https://gist.github.com/paul-krohn/e45f96181b1cf5e536325d1bdee6c949">Workaround for sockets on Docker on macOS</a></li>
348+
<li><a href="https://blog.jessfraz.com/post/how-to-use-new-docker-seccomp-profiles/">How to use new Docker seccomp profiles</a></li>
349+
<br/>
350+
351+
### Running the dev environment on Docker as a WSL user
352+
353+
Build the image using Dockerfile-WSL:
354+
```
355+
docker build -t overvue -f Dockerfile-WSL .
294356
```
295-
docker run -v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=$DISPLAY -v`pwd`/src:/app/src --rm -it <OverVue file name> bash
357+
358+
To run
296359
```
360+
docker run -v /tmp/.X11-unix:/tmp/.X11-unix -e DISPLAY=$DISPLAY -v`pwd`/src:/app/src --rm -it overvue bash
361+
```
362+
363+
Run in dev mode using:
364+
```
365+
npm run dev
366+
```
367+
<br/>
368+
297369
## BETA
298370
### Slack OAuth
299371

@@ -335,7 +407,7 @@ Here are some features we're thinking about adding:
335407
- More semantic HTML tag options
336408
- Ability to export Vuex store boilerplate
337409
- Ability to add two-way binding to input elements
338-
- More typing options for Typescript mode
410+
- More granular typing options for TypeScript mode
339411

340412
If you make changes and wish to update the website, here is the link to the repo: https://github.com/TeamOverVue/OverVuePage
341413

src/assets/add-props.png

15.7 KB
Loading

src/assets/component-details.png

101 KB
Loading

src/assets/delete-component.png

9.79 KB
Loading

src/assets/gear.png

1.67 KB
Loading

src/assets/html-queue.png

25.5 KB
Loading

src/assets/html_list.png

-14.6 KB
Binary file not shown.

src/assets/project-tree.png

80.7 KB
Loading

src/assets/props.png

23.9 KB
Loading

src/assets/rightsidebar.png

24.6 KB
Loading

0 commit comments

Comments
 (0)