diff --git a/onix-gui/REAME.md b/onix-gui/REAME.md new file mode 100644 index 0000000..339f6dc --- /dev/null +++ b/onix-gui/REAME.md @@ -0,0 +1,77 @@ +# Beckn-Onix Installation Wizard + + + +The below provides an overview of the installation wizard and layer 2 tester & downloader features of Beckn-Onix. Follow the steps outlined below to successfully utilize these features. + + + +### Home Page + +- Visit the home page of the Beckn-Onix installation wizard. + + + +![Home Page](https://github.com/beckn/beckn-onix/assets/85678545/e8674a29-b6e2-4fb2-a5ad-c76166bf1174) + + + +### Installation Wizard + +- Navigate to the installation wizard section. + +- Fill in the required details as prompted. + + + +![Installation Wizard](https://github.com/beckn/beckn-onix/assets/85678545/e9cec587-299f-4793-9045-c7c01551ad51) + + + +### Continue Installation + +- Click on the "Continue" button to proceed with the installation. + +- Repeat the same process for all components. + + + +## Layer 2 + + + +![Layer 2](https://github.com/beckn/beckn-onix/assets/85678545/32978858-5303-43b2-b0b5-517ee98ec6c3) + + + +### Setup Configuration File + +- Select whether you want to set up the layer 2 config file in BAP or BPP. + +- Fill in the Domain and version number of the layer 2 config file. + + + +### Check File Presence + +- If the file is present, a success toast will be displayed. + +- If the file is not present, a link for downloading the layer 2 file to the protocol server will be provided. + + + +![Check File Presence](https://github.com/beckn/beckn-onix/assets/85678545/31aaf210-9fef-4c33-b651-7231cd900f0a) + + + +### Download File + +- Click on the download link to be redirected to another page for downloading. + +- Paste the YAML file URL and click "Continue". + +- If successful, a success toast will be displayed. If unsuccessful, an error toast will be shown. + + + +![Download File](https://github.com/beckn/beckn-onix/assets/85678545/0dd9d456-66ca-4e2a-abc1-ba8dd98719c1)