Skip to content

Comments

Added Demo Web Application#72

Closed
rockyRaccoon13 wants to merge 149 commits intoni:mainfrom
Samuelsotogit:React
Closed

Added Demo Web Application#72
rockyRaccoon13 wants to merge 149 commits intoni:mainfrom
Samuelsotogit:React

Conversation

@rockyRaccoon13
Copy link
Collaborator

Justification

Added a React demo web application using Vite to demonstrate how a customer might create and deploy one to SystemLink (SL).

Implementation

  • Webapp Design

    • The web app was created in TypeScript/React with nimble design components
    • see examples/web_apps/Framework_Examples/React/ApiKeyAuthApp
  • Running in Dev (locally) vs Production (hosted in SL website)

    • Environment (.env.development and .env.production) files allow variable domain for fetches (dev will fetch from the local proxy server, prod will fetch from the hosting website)
  • ApiServiceProxy -- Required to run web app locally

    • To run in dev (locally), developers must call a SystemLink API URL with an API key
    • A proxy is required in order to circumvent browser cors issues
    • The proxy also allows for API authentication in development and session token authentication when the web app is hosted in the SystemLink website
    • Setup instructions for the proxy are included in ApiServiceProxy/README.md
  • Production -- Running inside SystemLink Website

    • In production, the webapp will call the same APIs at a SystemLink website URL
    • Instructions for deploying the webapp to production are included in the ApiKeyAuthApp/README.md
    • The webapp can also be built, and deployed using ./deployDev.sh

Testing

The webapp was run locally on a few devices using the proxy server and successfully called the API.

The webapp was also successfully deployed to SL website, where it was able to call the API for the logged in user.

The webapp source code passed a lint test (using SL rules) ran manually.

Checklist

@rockyRaccoon13 rockyRaccoon13 deleted the React branch February 20, 2026 18:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants