Merge pull request #40 from algorandfoundation/docs/remove-demo

refactor: remove demo dApp and flatten workspace

.dockerignore

@@ -1,3 +1,17 @@
+dist
 node_modules
-android
-clients/liquid-auth-client-kt
+.decisions
+.github
+.vscode
+docs
+__mocks__
+.eslintrc.json
+.gitignore
+.prettierrc
+ARCHITECTURE.md
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+docker-compose.yml
+Dockerfile
+README.md
+SEQUENCE.md

.env.docker

@@ -1,7 +1,7 @@
 # Application
 NODE_ENV=production
 SENTRY_DNS=
-PORT=5173
+PORT=3000
 
 # Database
 DB_HOST=mongo:27017

.gitignore

@@ -4,22 +4,18 @@ swagger-codegen-cli.jar
 ngrok.yml
 .data
 
-# Kotlin
-*.iml
-.gradle
-/local.properties
-/.idea/caches
-/.idea/libraries
-/.idea/modules.xml
-/.idea/workspace.xml
-/.idea/navEditor.xml
-/.idea/assetWizardSettings.xml
-.DS_Store
-/build
-/captures
-.externalNativeBuild
-.cxx
-local.properties
+assetlinks.json
+src/views
+src/public
+views
+public
+
+# Project Files
+.env.production
+.data
+.vercel
+.idea
+.vscode
 
 # Logs
 logs
@@ -101,7 +97,6 @@ web_modules/
 .env.test.local
 .env.production.local
 .env.local
-!sites/dapp-ui/.env
 
 # parcel-bundler cache (https://parceljs.org/)
 .cache
@@ -152,3 +147,6 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+# Sentry Config File
+.sentryclirc

Dockerfile

@@ -1,4 +1,6 @@
-FROM node:20.12-alpine AS BUILDER
+FROM node:22.8.0-alpine AS BUILDER
+
+WORKDIR /home/node
 
 ENV PYTHONUNBUFFERED=1
 RUN apk add --update --no-cache g++ make py3-pip pkgconfig pixman-dev cairo-dev pango-dev && ln -sf python3 /usr/bin/python
@@ -9,19 +11,19 @@ RUN npm ci
 
 RUN npm run build
 
-FROM node:20.12-alpine
+FROM node:22.8.0-alpine
+
+WORKDIR /home/node
+
+# Dependencies
+COPY --from=BUILDER /home/node/node_modules ./node_modules
 
 # App Files
-COPY --from=BUILDER ./node_modules ./node_modules
-COPY --from=BUILDER ./package.json ./package.json
-COPY --from=BUILDER ./package-lock.json ./package-lock.json
-# Sites Files
-COPY --from=BUILDER ./sites ./sites
-# Service Files
-COPY --from=BUILDER ./services/liquid-auth-api-js/ ./services/liquid-auth-api-js/
+COPY --from=BUILDER /home/node/dist ./dist
+COPY --from=BUILDER /home/node/src ./src
+COPY --from=BUILDER /home/node/package.json ./package.json
 
 # Expose the port on which the app will run
 EXPOSE 3000
-EXPOSE 5173
 
-CMD ["npm", "run", "start"]
+CMD ["npm", "run", "start:prod"]

README.md

@@ -13,6 +13,9 @@ A user must prove ownership of a private key to associate PublicKeyCredentials
 
 ## Getting started
 
+This guide is designed to get the project running locally in a dockerized container.
+See the full [Service Documentation](https://liquidauth.com/server/introduction/) for more information
+
 ### Prerequisites
 - Node.js 18+
 - Docker
@@ -29,22 +32,8 @@ git clone git@github.com:algorandfoundation/liquid-auth.git && cd liquid-auth
 
 Sign up for a free account at [ngrok](https://ngrok.com/) and follow the instructions to get your <NGROK_AUTH_TOKEN> and <NGROK_STATIC_DOMAIN>.
 
-#### With Docker
 Don't run the ngrok commands directly as expressed in the ngrok guide as it will create run-time port conflicts.
 
-#### Without Docker
-ngrok will ask you to add your auth token to your configuration file.
-
-``` bash
-ngrok config add-authtoken <NGROK_AUTH_TOKEN>
-```
-
-Will then ask you to deploy your static domain, make sure to change the port to **5173** like this:
-
-``` bash
-ngrok http --domain=<NGROK_STATIC_DOMAIN> 5173
-```
-
 #### Configure NGROK
 
 Add a `ngrok.yml` configuration to the root directory.
@@ -55,14 +44,14 @@ version: 2
 authtoken: <NGROK_AUTH_TOKEN>
 tunnels:
   website:
-    addr: liquid-auth:5173
+    addr: liquid-auth:3000
     proto: http
     domain: <NGROK_STATIC_DOMAIN>
 
 ```
 *Make sure to update the `authtoken` and `domain` in the `ngrok.yml` file with your ngrok details.*
 
-#### Update the Service's .env.docker file
+### Service Configuration
 
 Update the [.env.docker](.env.docker) file with the following keys with the values from ngrok:
 
@@ -71,35 +60,35 @@ HOSTNAME=<NGROK_STATIC_DOMAIN>
 ORIGIN=https://<NGROK_STATIC_DOMAIN>
 ```
 
-### Start services
+### User Interface
 
-Run the following command to start the backend:
+A quick way to test the service is using the documentation site included in this repository. 
+
+Navigate to the `docs` directory:
 
 ```bash
-docker-compose up -d
+cd docs
 ```
 
-Navigate to the ngrok URL in your browser to test the FIDO2 feature.
-
-
-## Using the app
+Copy the `.env.template` file to `.env`:
 
-#### Install the [Android client](https://github.com/algorandfoundation/liquid-auth-android/releases) to your device.
-
-![Step-1.png](.docs%2FStep-1.png)
-
-
-### QR Connect
-
-Open the Connect Modal on the website and scan the QR code using the "Connect" button on the Android device.
-Follow the instructions on the Android device to register a credential.
+```bash
+cp .env.template .env
+```
 
+Update the `.env` file with the <NGROK_STATIC_DOMAIN>
 
-![Step-1-QRCode.png](.docs%2FStep-1-QRCode.png)
+```bash
+PUBLIC_LIQUID_ORIGIN=<NGROK_STATIC_DOMAIN>
+```
 
+### Start services
 
-### Peer to Peer
+Run the following command to start the backend:
 
-Once the credential is registered, you can send messages over the peer connection.
+```bash
+docker-compose up -d
+```
 
-![Step-2.png](.docs%2FStep-2.png)
+Navigate to [https://localhost:4321](https://localhost:4321/#get-connected)
+to view the documentation and try the demo on the landing page.

docker-compose.yml

@@ -1,18 +1,23 @@
 services:
+  documentation:
+    build:
+      context: ./docs
+      target: DEV
+    depends_on:
+      - liquid-auth
+    ports:
+      - "4321:4321"
   liquid-auth:
     build: .
-    restart: no
     env_file:
       - .env.docker
     ports:
-      - "5173:5173"
+      - "3000:3000"
     depends_on:
       - redis
       - mongo
-    command: ["npm", "run", "start:ssr"]
   ngrok:
     image: ngrok/ngrok:latest
-    restart: no
     command:
       - "start"
       - "--all"
@@ -21,15 +26,13 @@ services:
     volumes:
       - ./ngrok.yml:/etc/ngrok.yml
     ports:
-      - 4040:4040
+      - "4040:4040"
   redis:
     image: redis
-    restart: always
     ports:
       - "6379:6379"
   mongo:
     image: mongo:7.0
-    restart: no
     environment:
       - MONGO_INITDB_DATABASE=${DB_NAME:-fido}
       - MONGO_INITDB_ROOT_USERNAME=${DB_USERNAME:-algorand}
@@ -38,23 +41,5 @@ services:
       - "27017:27017"
     volumes:
       - mongo:/data/db
-  turn:
-    image: coturn/coturn
-    restart: no
-    deploy:
-      replicas: 0
-    depends_on:
-      - mongo
-    ports:
-      - "3478:3478"
-      - "3478:3478/udp"
-      - "5349:5349"
-      - "5349:5349/udp"
-    command:
-      - "--no-auth"
-      - "--mongo-userdb"
-      - "mongodb://${DB_USERNAME:-algorand}:${DB_PASSWORD:-algorand}@mongo:27017/${DB_NAME:-coturn}?authSource=admin&retryWrites=true&w=majority"
-      - "--redis-userdb"
-      - "ip=redis dbname=0"
 volumes:
   mongo:

docs/.dockerignore

@@ -0,0 +1,17 @@
+dist
+node_modules
+.decisions
+.github
+.vscode
+docs
+__mocks__
+.eslintrc.json
+.gitignore
+.prettierrc
+ARCHITECTURE.md
+CODE_OF_CONDUCT.md
+CONTRIBUTING.md
+docker-compose.yml
+Dockerfile
+README.md
+SEQUENCE.md

docs/.env.template

@@ -0,0 +1 @@
+PUBLIC_LIQUID_ORIGIN=liquid-auth.onrender.com

docs/Dockerfile

@@ -0,0 +1,20 @@
+FROM node:22 AS BUILDER
+
+WORKDIR /home/node
+
+ENV PYTHONUNBUFFERED=1
+RUN apt-get update && apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev -y
+
+COPY . .
+
+RUN npm ci
+
+RUN npx playwright-core install --with-deps chromium && npm run build
+
+FROM node:22-slim as DEV
+
+WORKDIR /home/node
+
+COPY --from=BUILDER /home/node ./
+
+CMD ["npm", "run", "dev"]

docs/astro.config.mjs

@@ -29,17 +29,6 @@ export default defineConfig({
     logo: {
       src: "./public/logo.svg"
     },
-    head:[
-      {
-        tag: 'script',
-        attrs: {
-          // Tweaks to the script URL or attributes can be made here.
-          src: 'https://unpkg.com/htmx.org@1.9.6',
-          integrity: "sha384-FhXw7b6AlE/jyjlZH5iHa/tTe9EpJ1Y55RjcgPbjeWMskSxZt1v9qkxLJWNJaGni",
-          crossorigin: "anonymous",
-        },
-      },
-    ],
     editLink: {
       baseUrl: 'https://github.com/algorandfoundation/liquid-auth/edit/develop/docs/',
     },