Update overall repository

Author: Starefossen

.github/copilot-instructions.md

@@ -0,0 +1,64 @@
+
+# GitHub Copilot Instructions for This Repository
+
+Welcome to the Nais Examples repository! This document provides guidance for using GitHub Copilot effectively in this codebase. Please follow the instructions below to ensure consistency, quality, and best practices across all services and technologies in this repository.
+
+---
+
+## General Instructions
+
+- **Code Quality:** Always generate clean, readable, and idiomatic code. Follow the conventions of the language and framework in use.
+- **Documentation:** Add or update comments and documentation for new code, especially for public APIs and complex logic.
+- **Testing:** When adding new features or fixing bugs, generate or update relevant tests.
+- **Security:** Avoid hardcoding secrets or credentials. Use environment variables or secret management solutions.
+- **Error Handling:** Implement proper error handling and logging. Avoid silent failures.
+- **Consistency:** Follow the existing project structure and naming conventions.
+- **Dependencies:** Use only necessary dependencies. Prefer official or well-maintained libraries.
+- **Pull Requests:** Ensure all code passes linting, formatting, and tests before submitting a PR.
+
+---
+
+
+## Language & Framework Specific Instructions
+
+### 1. Next.js (Frontend)
+- Use functional React components and hooks.
+- Prefer TypeScript for new files/components.
+- Use Tailwind CSS for UI.
+- Organize components in the `components/` directory and pages in the `pages/` or `app/` directory.
+- Use Next.js API routes for backend logic only when necessary.
+- Optimize for accessibility and performance.
+- Use environment variables for configuration (never commit secrets).
+
+### 2. Kotlin + Ktor (Backend)
+- Use idiomatic Kotlin (prefer `val` over `var`, use data classes, etc.).
+- Organize code by feature (routes, services, repositories, models, etc.).
+- Use Ktor features for routing, dependency injection, and configuration.
+- Use JPA/Hibernate or Exposed for database access; prefer constructor injection.
+- Write integration and unit tests for routes and services.
+- Use configuration files (`application.conf` or `application.yaml`) for environment-specific settings.
+
+### 3. Go (Load Generator)
+- Use idiomatic Go (short variable names, error handling, etc.).
+- Organize code by package (cmd, internal, etc.).
+- Write clear, minimal code for load generation and HTTP requests.
+- Add comments and documentation for exported functions.
+- Write unit tests for core logic if applicable.
+
+### 4. PostgreSQL (Database)
+- Use migrations (e.g., Flyway, Liquibase, or manual SQL) for schema changes if needed.
+- Store connection details in environment variables or secrets.
+- Do not commit database dumps or sensitive data.
+
+### 5. Docker & Docker Compose
+- Write clear, minimal Dockerfiles for each service.
+- Use multi-stage builds for production images when possible.
+- Keep `docker-compose.yaml` up to date with all services and dependencies.
+- Expose only necessary ports and use environment variables for configuration.
+
+---
+
+## Additional Notes
+- For more details on each service, see the README in the respective subdirectory.
+- If you are unsure about conventions or best practices, refer to the official documentation for the language or framework in use.
+- When in doubt, prefer clarity and maintainability over cleverness.

.github/workflows/quotes-backend.yaml

@@ -54,13 +54,13 @@ jobs:
           dockerfile: ./quotes-backend/Dockerfile
           google_service_account: gh-examples
           push: ${{ github.actor != 'dependabot[bot]' }}
-          workload_identity_provider: ${{ secrets.NAIS_IO_WORKLOAD_IDENTITY_PROVIDER }}
+          workload_identity_provider: ${{ secrets.Nais_IO_WORKLOAD_IDENTITY_PROVIDER }}
     outputs:
       version: ${{ steps.image.outputs.version }}
   rollout:
     permissions:
       id-token: write
-    name: Deploy to NAIS
+    name: Deploy to Nais
     needs: ["test", "build_push_sign"]
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/main'

.github/workflows/quotes-frontend.yaml

@@ -36,13 +36,13 @@ jobs:
           dockerfile: ./quotes-frontend/Dockerfile
           google_service_account: gh-examples
           push: ${{ github.actor != 'dependabot[bot]' }}
-          workload_identity_provider: ${{ secrets.NAIS_IO_WORKLOAD_IDENTITY_PROVIDER }}
+          workload_identity_provider: ${{ secrets.Nais_IO_WORKLOAD_IDENTITY_PROVIDER }}
     outputs:
       version: ${{ steps.image.outputs.version }}
   rollout:
     permissions:
       id-token: write
-    name: Deploy to NAIS
+    name: Deploy to Nais
     needs: ["build_push_sign"]
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/main'

.github/workflows/quotes-loadgen.yaml

@@ -36,13 +36,13 @@ jobs:
           dockerfile: ./quotes-loadgen/Dockerfile
           google_service_account: gh-examples
           push: ${{ github.actor != 'dependabot[bot]' }}
-          workload_identity_provider: ${{ secrets.NAIS_IO_WORKLOAD_IDENTITY_PROVIDER }}
+          workload_identity_provider: ${{ secrets.Nais_IO_WORKLOAD_IDENTITY_PROVIDER }}
     outputs:
       version: ${{ steps.image.outputs.version }}
   rollout:
     permissions:
       id-token: write
-    name: Deploy to NAIS
+    name: Deploy to Nais
     needs: ["build_push_sign"]
     runs-on: ubuntu-latest
     if: github.ref == 'refs/heads/main'

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 NAV (Arbeids- og velferdsdirektoratet) - The Norwegian Labour and Welfare Administration
+Copyright (c) 2021 Nav (Arbeids- og velferdsdirektoratet) - The Norwegian Labour and Welfare Administration
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,50 +1,75 @@
-# Really NAIS examples
+# Really Nais Examples
 
-A collection of example apps demonstrating features and concepts in and around NAIS.
+This repository contains a collection of example applications for the Nais platform. The main example is a Quotes application, where users can view and create quotes. Each service demonstrates a specific technology stack and integration pattern commonly used in modern cloud-native applications on Nais.
 
-| Example                        | Language | Description                                                          |
-| ------------------------------ | -------- | -------------------------------------------------------------------- |
-| [shop-frontend](shop-frontend) | Next.js  | A simple webshop using [NAV's design system][aksel] and Tailwind CSS |
-| [shop-backend](shop-backend)   | Kotlin   | A simple Spring Boot API with a PostgreSQL database                  |
-| [sentiment-api](sentiment-api) | Kotlin   | A simple Spring Boot API with Google Cloud Sentiment Analysis        |
+Another key purpose of these examples is to showcase the observability features available in the Nais Platform, based on OpenTelemetry. This includes:
 
-A high-level overview of the example apps and their dependencies:
+- **Logs** collected in Loki
+- **Metrics** collected in Prometheus
+- **Traces** collected in Tempo
+
+All observability data is available and visualized in Grafana, making it easy to monitor, debug, and understand your applications running on Nais.
+
+## Purpose
+
+The purpose of this repository is to help developers understand how to:
+
+- Build and deploy frontend, backend, and load generation services on Nais
+- Integrate with managed databases (PostgreSQL)
+- Use modern frameworks and best practices for cloud applications
+
+## High-Level Overview
+
+This repository consists of the following services:
+
+| Service                            | Tech Stack                   | Purpose & Description                                                          |
+| ---------------------------------- | ---------------------------- | ------------------------------------------------------------------------------ |
+| [quotes-frontend](quotes-frontend) | Next.js, React, Tailwind CSS | The web frontend for the Quotes app, allowing users to view and submit quotes. |
+| [quotes-backend](quotes-backend)   | Kotlin, Ktor, PostgreSQL     | The backend API for the Quotes app, handling quote storage and retrieval.      |
+| [quotes-loadgen](quotes-loadgen)   | Go (Golang)                  | A load generator for simulating traffic and testing the Quotes application.    |
+
+For more details on each service, see the README in the respective subdirectory:
+
+- [quotes-frontend/README.md](quotes-frontend/README.md)
+- [quotes-backend/README.md](quotes-backend/README.md)
+- [quotes-loadgen/README.md](quotes-loadgen/README.md)
+
+## Architecture
+
+A high-level overview of the Quotes application and its dependencies:
 
 ```mermaid
 ---
 config:
-    flowchart:
-        defaultRenderer: elk
+  flowchart:
+    defaultRenderer: elk
 ---
 graph LR
+
   subgraph Browser
-    A(React.js)
+  A(React.js)
   end
 
   subgraph Frontend
-    B(Next.js)
+  B(Next.js + Tailwind CSS)
   end
 
   subgraph Backend
-    C(Spring Boot)
-    D(PostgreSQL)
+  C(Ktor)
+  D(PostgreSQL)
   end
 
-  subgraph Sentiment API
-    E(Spring Boot)
-    F(Google Cloud<br>Sentiment API)
+  subgraph Loadgen
+  E(Go)
   end
 
   A --> B
   B --> C
   C --> D
-  C --> E
-  E --> F
+  E --> B
 
 ```
 
-[aksel]: https://aksel.nav.no/
-
 ## License
 
 The code in this repository is licensed under the MIT license. See [LICENSE](LICENSE) for more information.

quotes-loadgen/README.md

@@ -96,7 +96,7 @@ export LOADGEN_DURATION=15
 
 ## Deployment
 
-The application can be deployed to the NAIS platform using the provided `.nais/config.yaml` file. Ensure the Docker image is pushed to a container registry accessible by NAIS.
+The application can be deployed to the Nais platform using the provided `.nais/config.yaml` file. Ensure the Docker image is pushed to a container registry accessible by Nais.
 
 ## License