This is a surfing app that integrates AI-powered swell and condition forecasting, alongside a social platform for surfers to connect and share their sessions. Users can log their surf sessions, share insights, and interact with others within the surfing community.

We welcome contributions to this project! If you're interested in contributing, please read our Contributing Guidelines for details on how to get started.

By following these guidelines, you'll help us maintain a consistent development process and ensure a smooth experience for all contributors.

• AI-Driven Forecasting: Get accurate swell and condition forecasts based on AI models.
• Session Logging: Log details of your surf sessions, including date, time, surf spot, wave conditions, and more.
• Social Interaction: Connect with other surfers, share session details, and interact with the community.
• Real-Time Data: AI-powered predictions for surf conditions, utilizing web scraping to gather data.

Salt/ ├── .github/ # GitHub Actions workflows │ └── workflows/ │ ├── docker-build-api.yml # API image builds │ ├── docker-build-app.yml # App image builds │ └── docker-build-scraper.yml # Scraper image builds ├── ansible/ # Infrastructure automation │ ├── ansible.cfg │ ├── hosts # Inventory file │ ├── playbooks/ │ │ ├── deploy_cluster.yaml │ │ ├── deploy_common.yaml │ │ ├── deploy_coredns.yaml │ │ ├── deploy_docker.yaml │ │ ├── deploy_helm.yaml │ │ ├── deploy_kubernetes.yaml │ │ ├── deploy_node_exporter.yaml │ │ ├── deploy_noip.yaml │ │ ├── deploy_postgres.yaml │ │ ├── deploy_postgres_exporter.yaml │ │ ├── deploy_s3_storage.yaml │ │ └── site.yaml │ ├── roles/ # Ansible roles for each service │ └── vars/ # Variable files (secrets encrypted) ├── api/ # Backend API (Express.js + TypeScript) │ ├── src/ # Source code │ ├── tests/ # Unit and integration tests │ └── salt-api.Dockerfile # Docker build configuration ├── app/ # Frontend application (React + Vite) │ ├── src/ # Source code │ ├── tests/ # Unit and integration tests │ └── salt-app.Dockerfile # Docker build configuration ├── helm/ # Kubernetes application deployments │ ├── STANDARDS.md # Helm chart conventions │ ├── argo-workflows/ # Workflow orchestration │ ├── grafana/ # Monitoring dashboards │ ├── minio/ # S3-compatible object storage │ ├── prometheus/ # Metrics collection │ ├── salt-api/ # Backend API deployment │ └── salt-app/ # Frontend app deployment ├── networking/ # Network setup scripts │ ├── boot_pi.sh │ └── init_host.sh ├── postgres/ # Database configuration │ ├── databases/ │ ├── roles/ │ └── users/ ├── web-scraping/ # Data collection jobs │ ├── jobs/ │ │ └── tests/ # Scraper tests │ ├── web-scraper.Dockerfile │ └── requirements.txt └── README.md 

Clone the repository and navigate into it:

git clone https://github.com/SurfLocal/Salt.git cd Salt

The README in the networking/ directory provides a detailed guide for setting up networking configurations on Raspberry Pi nodes. It begins with instructions for installing the Raspberry Pi OS and configuring hostnames. The first step involves using the Raspberry Pi Imager to install the OS, where users are prompted to configure a username and password for enabling SSH access. After the OS installation, the 'boot_pi.sh' script is executed to set a unique hostname for each Raspberry Pi and ensure SSH is enabled. This automates the pre-boot configuration, making it easier to prepare the devices for remote access.

Next, the init_host.sh script is used once the Raspberry Pis are booted and connected to the local network. This script facilitates the setup of secure, passwordless SSH access by generating and transferring SSH keys, and disabling password authentication on the remote machine for enhanced security. The README emphasizes that each Raspberry Pi should be configured with a specific hostname and ensures that SSH access is set up correctly for future, seamless connections.

The Ansible playbooks automate the installation and configuration of essential tools for setting up a containerized and Kubernetes-based environment. It begins by installing Docker on ARM64 systems, adding the necessary GPG key and repository, and ensuring that the user can run Docker commands without sudo. Helm, a package manager for Kubernetes, is also installed by downloading and executing its installation script.

The playbooks then handle the installation and configuration of K3s, a lightweight Kubernetes distribution. The master node is initialized and the necessary join token is retrieved to add worker nodes to the cluster. Systemd services are enabled for both the K3s master and worker nodes to ensure they start automatically on boot. Additionally, Node Exporter is installed to collect system metrics for Prometheus monitoring, and the No-IP Dynamic Update Client (DUC) is configured for dynamic DNS management.

Finally, PostgreSQL is installed and configured to run with its data directory stored on a larger partition. The playbooks ensure PostgreSQL is set up to listen on both localhost and Kubernetes nodes and create a custom systemd service to manage its startup. These playbooks streamline the setup process by automating the installation and configuration of critical tools for development or production environments.

Once the infrastructure for Kubernetes and PostgreSQL is set up, applications and workflows are managed and deployed to the cluster using Helm. Helm simplifies the deployment process by providing a consistent, repeatable way to manage Kubernetes applications.

Current Deployments:

• Argo Workflows: Orchestrates scheduled data scraping jobs (hourly swell and wind data collection)
• MinIO: S3-compatible object storage for workflow logs and artifacts (100Gi SSD storage)
• Prometheus: Metrics collection and monitoring for all cluster nodes and PostgreSQL database

All Helm charts follow standardized conventions documented in helm/STANDARDS.md, ensuring consistent structure, proper templating, and maintainability. See the Helm README for detailed deployment instructions.

1. Install Homebrew: If Homebrew is not installed, install it by running:

   /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

2. Install Ansible:

   brew install ansible

3. Install iproute2mac: The ip command (part of iproute2mac) is used to retrieve the router IP and perform other network-related tasks.

   brew install iproute2mac