2. Project Layout
In this section, we will discuss the layout and directory structure of the Basic Application tutorial.
- Introduction to JS Development Environment
- Required Libraries
As mentioned in the previous section, HOOPS Communicator ships with a Node.js server, which will serve up the samples included in the package. The following sections will assume you have executed the start_server.bat/sh script from Getting Started and still have that server running. While the server is well-suited for this guide, it is not intended for production use.
You are free to use your preferred IDE throughout this guide. However, if you are looking for a suggestion we recommend Visual Studio Code, which is a lightweight, cross-platform editor.
In your installation directory for HOOPS Communicator, we have provided a library of sample code that corresponds to tutorials in this documentation. There is a directory named basic_app that holds all of the starting files you need to start this tutorial. You will find other directories with names that correspond to the tutorials listed in the sidebar to the left under Tutorials.
Let's take a closer look at the contents of the basic_app directory.
- start_server.[bat|sh] – This script will start the same HOOPS Server used in Getting Started, but slightly modified to serve the files from this project and not Getting Started.
- server_config.js – This file contains the HOOPS Server configuration.
The file hoops_web_viewer.js contains the core functionality of the HOOPS Web Viewer component and has dependencies on engine-asmjs.js, engine-wasm.js, engine.wasm. Copy all these hoops into /js/hoops of your project. To keep things simple, we will not use the HOOPS Web Viewer UI for this tutorial.