https://github.com/hcl-tech-software/volt-mx-tutorials
HCL Volt MX Tutorials
https://github.com/hcl-tech-software/volt-mx-tutorials
volt-mx
Last synced: 5 months ago
JSON representation
HCL Volt MX Tutorials
- Host: GitHub
- URL: https://github.com/hcl-tech-software/volt-mx-tutorials
- Owner: HCL-TECH-SOFTWARE
- License: apache-2.0
- Created: 2021-03-30T12:26:25.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-14T04:18:53.000Z (about 2 years ago)
- Last Synced: 2024-12-20T12:15:46.037Z (5 months ago)
- Topics: volt-mx
- Language: JavaScript
- Homepage: https://opensource.hcltechsw.com/volt-mx-tutorials/hikes
- Size: 22.1 MB
- Stars: 9
- Watchers: 5
- Forks: 25
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
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.
Table of Contents
## 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.
```sh
npm install
```
4. Run in development mode
```
npm start
```
5. **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,
```node
npm run-script hikeBuilder:install --path="IRIS_INSTALLATION_PATH"
```
**Uninstall:**
From root directory,
```node
npm run-script hikeBuilder:uninstall --path="IRIS_INSTALLATION_PATH"
```
eg: in macOS,
```node
npm run-script hikeBuilder:install --path="/Applications/Volt MX Iris"
```
eg: in Windows,
```node
npm run-script hikeBuilder:install --path="C:\Program Files\Volt MX Iris"
```
## Production Build
### builds the production application in the .next folder
```node
npm run build
```
After building, `next start` starts a Node.js server that supports hybrid pages.
### export as static HTML
```node
npm run export
```
## Contributing
Read our [Contributing Guide](/.github/CONTRIBUTING.md) 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](/LICENSE)