Project layout

Summary

In this chapter, we will discuss the layout and directory structure of the Product Configurator tutorial.

Concepts

  • VS Code directory structure

  • Overview of provided files

These tutorials will use a working development environment to enable you to code along through this exercise. If you have not already reviewed the Environment setup section of these tutorials, please do that first.

Once you have VS Code set up and Node.js installed, open the Product Configurator project directory in your editor.

product_configurator
├── data
│   ├── attachPoints.json
│   └── scs
├── favicon.ico
├── img
├── index.html
├── package-lock.json
├── package.json
└── src
    ├── css
    └── js

A brief overview of this directory structure:

  • data – external data for the application
    • scs - SCS models and thumbnails generated from native CAD formats
    • thumbnails - thumbnails for models that will be used
    • attachPoints.json - JSON file containing relationships between unique, previously unrelated parts
  • src – source code for the application
    • css – style sheets for the application
    • img – static image assets used by the application
    • js – where we will write and place our application Javascript files
  • favicon.ico – TS3D browser tab icon
  • index.html – defines the document hierarchy and entry point of our application
  • package.json – defines our project structure and lists any development dependencies to install

In order to focus more on the HOOPS Communicator WebViewer API, we have provided the HTML, CSS, and project configuration files for you, so you do not need to write them yourself.