|
22 | 22 | - [How to use](#how-to-use) |
23 | 23 | - [Installation](#installation) |
24 | 24 | - [WSL Installation](#wsl-installation) |
25 | | - - [Running as Containerized Docker Image](#running-as-containerized-docker-image) |
| 25 | + - [Running the Docker Image](#running-the-docker-image) |
26 | 26 | - [BETA](#beta) |
27 | 27 | - [Slack OAuth](#slack-oauth) |
28 | 28 | - [Contributing](#contributing) |
@@ -212,14 +212,15 @@ src/ |
212 | 212 | UserCreatedComponent1.vue |
213 | 213 | UserCreatedComponent2.vue |
214 | 214 | ... |
| 215 | + router/ |
| 216 | + index.js |
215 | 217 | views/ |
216 | 218 | HomeView.vue |
217 | 219 | UserCreatedRouteComponent1.vue |
218 | 220 | UserCreatedRouteComponent2.vue |
219 | 221 | ... |
220 | 222 | App.vue |
221 | 223 | main.js |
222 | | - router.js |
223 | 224 | babel.config.js |
224 | 225 | package.json |
225 | 226 | ``` |
@@ -287,13 +288,84 @@ Then open a new terminal instance, set the DISPLAY value again (re-enter above c |
287 | 288 | ``` |
288 | 289 | quasar dev -m electron |
289 | 290 | ``` |
290 | | -### Running as Containerized Docker Image |
| 291 | +## Running the Docker Image |
291 | 292 |
|
292 | | -In your terminal, run : |
| 293 | +To run the built version, pull down the docker image from [Docker repo] |
293 | 294 |
|
| 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 . |
294 | 356 | ``` |
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 |
296 | 359 | ``` |
| 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 | + |
297 | 369 | ## BETA |
298 | 370 | ### Slack OAuth |
299 | 371 |
|
@@ -335,7 +407,7 @@ Here are some features we're thinking about adding: |
335 | 407 | - More semantic HTML tag options |
336 | 408 | - Ability to export Vuex store boilerplate |
337 | 409 | - Ability to add two-way binding to input elements |
338 | | -- More typing options for Typescript mode |
| 410 | +- More granular typing options for TypeScript mode |
339 | 411 |
|
340 | 412 | If you make changes and wish to update the website, here is the link to the repo: https://github.com/TeamOverVue/OverVuePage |
341 | 413 |
|
|
0 commit comments