TABLE OF CONTENTS
- Introduction
- Prerequisites
- Installation and Setup
- How to Customize Znode
- Logging and Debugging
- Deployment of Custom Applications
- Logging and Debugging
- How to Get an Updated Webstore and Custom API SDK
Introduction
This article is designed to help tenant users set up, configure, and customize Znode 10. It outlines the steps to configure the development environment, run the Webstore, and access the hosted Admin and API applications. It also provides an overview of basic Znode 10 customizations and features.
Prerequisites
Before starting, ensure the following:
- Complete the Znode tenant onboarding process.
- Obtain the required Znode developer tokens and NuGet credentials. Contact the Znode Support team if the CLI token is not available.
- Install and configure the Znode CLI to download the React Storefront source code and the Custom API template.
- Follow the steps outlined in the Znode CLI Setup Guide.
Installation and Setup
Step 1: Znode NuGet Source and CLI Setup
Configure Znode using the credentials provided by the support team:
- Source: https://nuget.znode.com/nuget
- Username: znode-nuget@znode.com
- Password: A!zNode2024#
Step 2: Access Token
Use the developer access token provided by the Znode Support team.
Step 3: Run Applications Locally
Verify and update configurations to use non-production gateways.
- To run the Webstore:
npx nx run webstore:dev
- To run the Page Builder:
npx nx run page-builder:dev
Note: Both applications must run simultaneously to test the Webstore.
Step 4: Source Control - Repositories
After downloading the source, create and commit the code to the appropriate source control repository to support future development and maintenance.
Step 5: Admin Application
Access the Admin Console using the assigned non-production instance credentials provided by the Znode Support team.
Step 6: Znode 10 - Znode CLI GitHub Action Guide
Refer to the “Znode 10 - Znode CLI GitHub Action Guide” for instructions on setting up GitHub-based automation.
How to Customize Znode
Webstore Customization
The Webstore is built as an open-source React application and can be modified to meet custom business requirements.
Refer to the following resources:
Custom APIs
Znode provides flexibility to create or modify APIs to meet specific needs.
Refer to the Custom API Development Guide.
ERP Connectors
Integrate third-party Enterprise Resource Planning (ERP) systems with Znode using the ERP Integration Guide.
Custom Admin
To customize the Admin Console, refer to the Custom Admin Development Guide.
Logging and Debugging
Exposing Localhost Using Cloudflare
Use tools such as Cloudflare to expose the localhost environment for external testing.
Logging in Custom Applications
Set up logging to track issues and performance in custom applications.
Deployment of Custom Applications
Use the CLI deployment commands to deploy custom Webstore and API applications to the assigned Znode 10 non-production instance.
For production deployments, follow the deployment guidelines provided by the Znode Support team.
Logging and Debugging
Set up logging for your custom application.
For advanced debugging, use tools like Cloudflare to expose localhost for testing.
How to Get an Updated Webstore and Custom API SDK
Use the following command to fetch the latest updates for both Webstore and Custom API SDK from the release repository:
znode get-updated-copy
Refer to the “Znode 10 SDK Update” documentation for detailed steps.