mirror of
https://github.com/yeicor-3d/yet-another-cad-viewer.git
synced 2025-12-20 06:27:04 +01:00
Compare commits
2 Commits
v0.2.0-alp
...
v0.2.0
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
986db75b24 | ||
|
|
962eea2b27 |
26
README.md
26
README.md
@@ -18,29 +18,11 @@ in a web browser.
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
The [example](example) is a fully working project that demonstrates how to use the viewer.
|
The [example](example) is a fully working project that shows how to use the viewer.
|
||||||
|
|
||||||
### Hot reloading
|
You can play with the latest
|
||||||
|
demo [here](https://yeicor-3d.github.io/yet-another-cad-viewer/?preload=base.glb&preload=fox.glb&preload=img.jpg.glb&preload=location.glb)
|
||||||
To see the live updates you will need to run the [yacv_server](yacv_server) and
|
|
||||||
open [the viewer](https://yeicor-3d.github.io/yet-another-cad-viewer/) with
|
|
||||||
the `preload=ws://<host>:32323/` query parameter (by default it already tries localhost).
|
|
||||||
|
|
||||||
Note that [yacv_server](yacv_server) also hosts the frontend at `http://localhost:32323/` if you have no access to the
|
|
||||||
internet.
|
|
||||||
|
|
||||||
### Static deployment
|
|
||||||
|
|
||||||
To deploy the viewer and models as a static website you can simply copy the latest build directory to your server.
|
|
||||||
To load models use the `preload=...` query parameter in the URL.
|
|
||||||
It can be set multiple times to load multiple models.
|
|
||||||
|
|
||||||
Note that you can simply reuse the [main deployment](https://yeicor-3d.github.io/yet-another-cad-viewer/) and host only
|
|
||||||
your own models (linking them from the viewer with the `preload` query parameter).
|
|
||||||
|
|
||||||
To see a working example of a static deployment you can check out
|
|
||||||
the [demo](https://yeicor-3d.github.io/yet-another-cad-viewer/?preload=base.glb&preload=fox.glb&preload=img.jpg.glb&preload=location.glb)
|
|
||||||
(or
|
(or
|
||||||
the [demo without animation](https://yeicor-3d.github.io/yet-another-cad-viewer/?autoplay=false&preload=base.glb&preload=fox.glb&preload=img.jpg.glb&preload=location.glb)).
|
[without animation](https://yeicor-3d.github.io/yet-another-cad-viewer/?autoplay=false&preload=base.glb&preload=fox.glb&preload=img.jpg.glb&preload=location.glb)).
|
||||||
|
|
||||||

|

|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "yet-another-cad-viewer",
|
"name": "yet-another-cad-viewer",
|
||||||
"version": "0.1.0",
|
"version": "0.2.0",
|
||||||
"description": "",
|
"description": "",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"author": "Yeicor <4929005+Yeicor@users.noreply.github.com>",
|
"author": "Yeicor <4929005+Yeicor@users.noreply.github.com>",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
[tool.poetry]
|
[tool.poetry]
|
||||||
name = "yacv-server"
|
name = "yacv-server"
|
||||||
version = "0.1.0" # TODO: Update automatically by CI on release (also for package.json!)
|
version = "0.2.0" # TODO: Update automatically by CI on release (also for package.json!)
|
||||||
description = "Yet Another CAD Viewer (server)"
|
description = "Yet Another CAD Viewer (server)"
|
||||||
authors = ["Yeicor <4929005+Yeicor@users.noreply.github.com>"]
|
authors = ["Yeicor <4929005+Yeicor@users.noreply.github.com>"]
|
||||||
license = "MIT"
|
license = "MIT"
|
||||||
|
|||||||
Reference in New Issue
Block a user