Skip to content

Latest commit

 

History

History
74 lines (58 loc) · 1.46 KB

README.md

File metadata and controls

74 lines (58 loc) · 1.46 KB
Raw

Sparse

SPA (Single-page application) runtimes for portable builds.

How It Works

A Sparse runtime replaces Environment Variable references in the SPA entrypoint HTML with their values from the Environment.

Example

  1. Clone this repository OR create an index.html entrypoint
<!DOCTYPE html>
<html lang="en">
  <body>
    <script type="text/javascript">
      window.config = {
        API: "$API_URL",
      };
    </script>
  </body>
</html>
  1. Launch the sparse runtime, e.g: docker-nginx
docker run \
  --volume $(PWD):/srv \
  --publish 8080:8080 \
  --env API_URL="https://api.example.com" \
  ghcr.io/pr-mpt/sparse-docker-nginx
  1. Observe Environment Variable replacement in page source at localhost:8080⇗
open http://localhost:8080
<!DOCTYPE html>
<html lang="en">
  <body>
    <script type="text/javascript">
      window.config = {
        API: "https://api.example.com",
      };
    </script>
  </body>
</html>

Specification

  • Environment Variables are strings
  • Default to empty string value
  • Replacement must be performed at startup, may be performed on each request
  • index.html is the application Entrypoint where variables are replaced
  • Passthrough all other paths to the filesystem
  • Allow port specification, default to 8080

Runtimes