Skip to content

VCityTeam/UD-Viz-Template

Repository files navigation

UD-Viz-demo

UD-Viz is an Demonstrations illustating some usages of the UD-Viz JS library.

The following sub-directories hold pure front-end indenpedent applications

DemoFull: client application (working with vanilla http server)
ImuvEditor: client application (working with vanilla http server)

In opposition Imuv is a front-end application requiring ImuvServer its back-end node application providing an http server and a websocket communication layer (expecting Imuv client connections),

Installing the demo applications

Pre-requisites

  • Ubuntu

  • Windows

    • Installing from the installer

    • Installing with the CLI

      iex (new-object net.webclient).downstring(‘https://get.scoop.sh’)
      scoop install nodejs

Installing the pure front-end demos (DemoFull and ImuvEditor)

In order to install the pure front-end demos

  • enter the chosen sub-directory,
  • launch npm install (to install the demo package dependencies),
  • run the demo with npm run debug command,
  • eventually open http://localhost:8000/ with your favorite (web) browser.

For example the DemoFull application can be locally (on your desktop) started in the following way

cd DemoFull
npm install
npm run debug      # integrates building

and then use your favorite (web) browser to open http://localhost:8000/.

Note that technically the npm run debug command will use the webpack-dev-server npm package that

  • runs node application that in turn launched a vanilla http sever in local (on your desktop)
  • launches a watcher (surveying changes in sources)
  • in case of change that repacks an updated bundle
  • that triggers a client (hot) reload

Notes: TO BE CHECKED !

  • If you want to change the listening port use
    npm run debug -- --port=8081
  • if you want this server to be visible from another host (than the one running this npm based server) then (as documented in this issue) use
    npm run debug -- --host=0.0.0.0
    or alternatively
    npm run debug -- --host=<the_host_IP_number>

Notes on the DemoFull

FIXME: unmature section

Some modules used by the DemoFull require some server-side components to be installed on some server (possibly your desktop). For example

About

Demonstrations provided with UDSV

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 10