refactor: rename example to quickstart

.github/workflows/docker-publish.yml

@@ -31,8 +31,8 @@ jobs:
         include:
           - context: ./backend
             image: ghcr.io/teamhanko/hanko
-          - context: ./example
-            image: ghcr.io/teamhanko/hanko/example
+          - context: ./quickstart
+            image: ghcr.io/teamhanko/hanko/quickstart
           - context: ./elements
             image: ghcr.io/teamhanko/hanko/elements
           - context: ./frontend-sdk

README.md

@@ -74,7 +74,7 @@ docker compose -f deploy/docker-compose/quickstart.yaml -p "hanko-quickstart" up
 ```
 > **Note**: Docker (Desktop) needs to be running in order for the command to run.
 
-After the services are up and running, the example login can be opened at `localhost:8888`. To receive emails without your own
+After the services are up and running, the login page can be viewed at `localhost:8888`. To receive emails without your own
 smtp server, we added [mailslurper](https://github.com/mailslurper/mailslurper) which will be available at `localhost:8080`.
 
 > **Note**: Hanko services are not published to a registry yet and will be built locally before the services are started.
@@ -84,7 +84,7 @@ The Hanko project consists of
 - [backend](/backend/README.md) - An authentication API powering passkeys, passcodes, and passwords, as well as user management and JWT token issuing
 - [hanko-elements](/elements/README.md) - A slick web component made for Hanko backend that features a polished onboarding and login experience and is highly customizable
 - [hanko-frontend-sdk](/frontend-sdk/README.md) - A client package for using the Hanko API
-- [example](/example) - The quickstart example app, showing off Hanko's login experience and acting as a reference implementation
+- [quickstart](/quickstart) - The quickstart example app, showing off Hanko's login experience and acting as a reference implementation
 - [examples](/examples) - Hanko example implementations for a number of frameworks
 - [docs](/docs) - The Hanko documentation
 

deploy/docker-compose/quickstart.debug.yaml

@@ -67,8 +67,8 @@ services:
       - "9501:80"
     networks:
       - intranet
-  example:
-    build: ../../example
+  quickstart:
+    build: ../../quickstart
     ports:
       - "8888:8080"
     environment:

deploy/docker-compose/quickstart.yaml

@@ -58,8 +58,8 @@ services:
       - "9501:80"
     networks:
       - intranet
-  example:
-    build: ../../example
+  quickstart:
+    build: ../../quickstart
     ports:
       - "8888:8080"
     environment:

e2e/README.md

@@ -27,7 +27,7 @@ To run the tests you need to have the following software installed:
 Furthermore, you need running instances of:
 
 - the Hanko [backend](../backend)
-- a running frontend application (e.g. our [example](../example)) using the web component provided by
+- a running frontend application (e.g. our [quickstart](../quickstart)) using the web component provided by
   [hanko-elements](../elements)
 - [Mailslurper](https://github.com/mailslurper/mailslurper) as an SMTP server (used to test passcodes through mail
   retrieval via its [API](https://github.com/mailslurper/mailslurper/wiki/API-Guide))

quickstart/Dockerfile

@@ -0,0 +1,17 @@
+# Build the quickstart binary
+FROM golang:1.17 as builder
+
+WORKDIR /workspace
+COPY . .
+
+RUN CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -o quickstart main.go
+
+# Use distroless as minimal base image to package quickstart binary
+# See https://github.com/GoogleContainerTools/distroless for details
+FROM gcr.io/distroless/static:nonroot
+WORKDIR /
+COPY --from=builder /workspace/quickstart .
+COPY /public /public
+USER 65532:65532
+
+ENTRYPOINT ["/quickstart"]

example/go.mod → quickstart/go.mod

@@ -1,4 +1,4 @@
-module github.com/teamhanko/hanko/example
+module github.com/teamhanko/hanko/quickstart
 
 go 1.17
 

example/main.go → quickstart/main.go

@@ -3,7 +3,7 @@ package main
 import (
 	"github.com/labstack/echo/v4"
 	mw "github.com/labstack/echo/v4/middleware"
-	"github.com/teamhanko/hanko/example/middleware"
+	"github.com/teamhanko/hanko/quickstart/middleware"
 	"html/template"
 	"io"
 	"log"