Overview

The uiFOSSA StatusNode.js CI repository contains the source code for the official user interface of the Polygon Open-Source Project. This user interface allows users to interact with the Polygon core instance.

Features

• Local Execution: Users can run the Polygon’s UI locally by setting environment variables in a .env.local file.
• Environment Variables: Users need to set the POLYGON_CORE_URL variable, which is the URL of the Polygon core instance, and the IRON_SESSION_SECRET variable, a 512-bit random string for cookie encryption.
• Production Build: Users can also run an optimized production build of the UI.
• Cloud Deployment: Users can deploy their instance of Polygon’s UI to popular cloud providers like Netlify or Vercel. Deployment with these providers is made easy by clicking deployment buttons.

Installation

To run Polygon’s UI locally, follow these steps:

1. Set several environment variables in a .env.local file in the project’s root:

   • POLYGON_CORE_URL: The URL of your Polygon core instance.
   • IRON_SESSION_SECRET: A 512-bit random string for cookie encryption.

2. After setting the variables, run the following command to start the UI:

[command to start the UI]

To deploy Polygon’s UI to a cloud provider:

1. Choose a cloud provider like Netlify or Vercel.
2. Click the corresponding deployment button (Deploy with Vercel or Deploy to Netlify) to initiate the deployment process.
3. If using Netlify, make sure to follow Netlify’s environment variable declaration documentation to set required environment variables from the control panel.

Summary

The uiFOSSA StatusNode.js CI repository hosts the source code for the official user interface of the Polygon Open-Source Project. It provides users with the ability to run the UI locally, set environment variables, run a production build, and deploy the UI to popular cloud providers. By following the installation instructions, users can easily set up and utilize the Polygon UI for their projects.