Volt MX Tutorials

Volt MX Tutorials is a mechanism within Volt MX Iris that you can use to learn a few concepts of how to develop applications by using Iris. Volt MX Tutorials are step-by-step interactive walkthroughs that help you understand the basics of using Volt MX Iris.

Explore the Catalog »

Table of Contents

1. Getting Started
   • Prerequisites
   • Quickstart
2. Usage
3. Contributing
4. License

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running.

Prerequisites

• npm >= 7.6.0
• node >= 15.11

Quickstart

1. Fork this repository & clone it in your local machine.

2. Install NPM packages.

   npm install

3. Run in development mode

   npm start
   

4. Dev Url: Open http://localhost:3200/ in your browser to see your app running.

Usage

HikeBuilder (Iris-Addon)

IRIS_INSTALLATION_PATH = the full path of your Volt MX Iris directory.

Install:

From root directory,

npm run-script hikeBuilder:install --path="IRIS_INSTALLATION_PATH"

Uninstall:

From root directory,

npm run-script hikeBuilder:uninstall --path="IRIS_INSTALLATION_PATH"

eg: in macOS,

npm run-script hikeBuilder:install --path="/Applications/Volt MX Iris"

eg: in Windows,

npm run-script hikeBuilder:install --path="C:\Program Files\Volt MX Iris"

Production Build

builds the production application in the .next folder

npm run build

After building, next start starts a Node.js server that supports hybrid pages.

export as static HTML

npm run export

Contributing

Read our Contributing Guide to learn about our development process, how to propose bug fixes and improvements and raise a pull a request.

License

Copyright HCL America, Inc. under Apache License