How Do I?

At a high level, the work flow for creating a new CH5 project is as follows:

  1. Issue the ch5-shell-cli create:project command in a new Visual Studio Code project as described in Setup.
  2. Open the Crestron Template Project root directory in Visual Studio Code, which includes the package.json file.
  3. From a console, issue npm install if this has not yet been done.
  4. Add any pages and widgets needed for the project.
  5. Modify items such as the logo, favorite icon, theme, and navigation menu.
  6. Issue npm run start to see the output in a browser.

The following topics provide common tasks and questions regarding project development to help guide you through using the template.

NOTE: Each Crestron Template Project command has a help function that can be accessed by issuing npm run [base command] -- --help. For example, help for the Update Project function can be accessed by issuing npm run update:project -- --help.

This section provides the following information: