---

Web Client for SlideRule Earth

This repository contains the web client for SlideRule Earth, built on top of the secure static site architecture derived from Amazon CloudFront Secure Static Site v0.11. The UI/UX was developed at the Savannah College of Art and Design by the following:

• Gabriel Mateleo
• Vincent Lee

Overview

The web client provides a user-friendly interface for interacting with SlideRule Earth, a server designed to process geospatial data and offer customizable analytical tools. This client allows users to visualize data, manage layers, and perform various geospatial operations in an interactive and secure environment.

Features

• Secure Static Hosting: The architecture is based on AWS CloudFront for secure content delivery.
• Interactive Geospatial Data: Allows interaction with different datasets and tools provided by the SlideRule Earth server.
• Customizable Visualization: Users can visualize and process geospatial data using various maps and tools.

Getting Started

To run this web client locally, follow the instructions below.

Prerequisites

• Node.js — exact version pinned in .nvmrc. Use fnm (recommended) or nvm: fnm install && fnm use.
• npm — version pinned by the packageManager field in package.json. Enable Corepack once with corepack enable && corepack enable npm and it will fetch the right version automatically.
• See CONTRIBUTING.md for full setup and the make install-deps vs npm install rule.

Installation

1. Clone this repository:

   git clone https://github.com/SlideRuleEarth/sliderule-web-client.git
   cd sliderule-web-client

2. Install npm dependencies (installs both the root and web-client/ packages via npm ci):

   make install-deps

3. Run the development server:

   make run

4. Build for production:

   make build

5. See all available commands:

   make help

Open Source Packages

This project uses a variety of open source libraries to enhance functionality. Below is a list of key packages used:

• Vue.js 3 - Frontend framework for building interactive web apps.
• Vite – Next-generation frontend build tool that provides fast development and optimized production builds.
• PrimeVue - UI component library for Vue.js.
• ECharts - Charting library for creating data visualizations.
• OpenLayers - High-performance library for displaying and interacting with map data.
• Deck.gl - WebGL-powered framework for visualizing large datasets.
• Pinia - State management library for Vue.js.
• DuckDB WASM - An WebAssembly embeddable SQL database for data processing.
• Apache Arrow - Data interchange format for in-memory analytics.

Deployment

This project is designed to be deployed as a secure static site using Amazon CloudFront and AWS S3. Refer to the Amazon CloudFront Secure Static Site repository for detailed instructions on setting up a similar architecture.

We use HashiCorp Terraform to deploy this website.

License

This project is licensed under the following University of Washington Open Source License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue for any improvements or feature requests.

Contact

For questions or support, please open an issue or contact the project maintainers at sliderule@u.washington.edu.

---