Playground deployment for prototyping (optional)
Quickly deploy your web client playground and see it in action
Last updated
Was this helpful?
Quickly deploy your web client playground and see it in action
Last updated
Was this helpful?
Please note that this deployment is just for the demo-playground. This is optional and does not replace the integration step. In order to go-live, please integrate the web client onto your app before the deployment of your app
An AWS account (you can create an account if you do not have one)
NoteYou can directly start from if you have installed and configured AWS CLI
Confirm the installation with the following command
aws-cli/2.10.0 Python/3.11.2 Linux/4.14.133-113.105.amzn2.x86_64 botocore/2.4.5 --> expected response
For this step you would need the following from you AWS account
Access key ID
Secret Access Key
Once you have the keys run the below command
The playground can help you get a look and feel of your checkout page and can be used for quickly prototyping your changes. The React Demo App in hyperswitch-web setups the playground for you-> which is a fullstack application. We ensure that the secret key stays in the server side and the publishable key stays in the client side, we insist you do the same for your application when you move to a Production ready setup
You can now deploy the Hyperswitch web client application by running the below command in the same terminal session
On running the above command, you will get an option to configure the following:
Mandatory:
Publishable Key - This is a public key that resides on your client side for authentication
Secret Key - This is the API key which should only be restricted to your app server
Optional:
URL where you have hosted Hyperswitch Backend - The base URL where you have hosted the app server. If not provided, this will default to https://sandbox.hyperswitch.io
URL where you have hosted Hyperswitch Client SDK - This is the HyperLoader.js path (for e.g. https://{domain}.s3.amazonaws.com/{path}). If not provided, this will default to https://beta.hyperswitch.io/v1
AWS Region - This is the AWS region where you will host you web client. If not provided, it will default to us-east-2.
Depending on the API version and changes made to the web client, the web client may or may not be compatible with the SaaS app server.
Once the script is executed, you will receive a Public IP as the response (e.g. http://34.207.75.225). This IP is the base URL for accessing the web client playground.
That's it! Hyperswitch web client should be up and running on your AWS account
Verify the application by opening this public IP in a web browser. Sometimes AWS can take upto 5 mins to initiate the EC2 instance.
If you want to delete the application from your account simply run the below clean up script
For more information,
You can create or manage your access keys from the Security Credentials tab inside your AWS Console. For more information,
You will either get these keys as an output when you host the app server, or for quick prototyping, you can create a new Hyperswitch sandbox account and get started.
You need JQ installed for this. For more information,
