From ce75747f5c2c6c1c27e188905ce4e0cd74fbdb07 Mon Sep 17 00:00:00 2001
From: Michael Feher <michael.feher@algorand.foundation>
Date: Mon, 22 Apr 2024 14:57:14 -0400
Subject: [PATCH] chore: cleanup files and update README

---
 CONTRIBUTING.md              | 72 +-----------------------------------
 README.md                    | 24 +++---------
 docker-compose.developer.yml | 10 -----
 ngrok.template.yml           |  7 ----
 4 files changed, 6 insertions(+), 107 deletions(-)
 delete mode 100644 docker-compose.developer.yml
 delete mode 100644 ngrok.template.yml

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a6d659c..146feaa 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,73 +1,3 @@
-# Overview
+# Overview[WIP]
 
 This is a guide on how to get the project running and how to contribute
-
-
-## Getting started
-
-### Prerequisites
-- Node.js 20
-- Docker
-
-#### Clone the project
-
-```bash
-git clone git@github.com:algorandfoundation/liquid-auth.git && cd liquid-auth
-```
-
-#### Install package dependencies
-
-```bash
-npm install
-```
-
-#### Build Dependencies
-
-```bash
-npm run build
-```
-
-WebAuthn requires a secure context (HTTPS) to work and this will not allow you to test the FIDO2 feature in your local machine.
-
-### NGROK
-
-Sign up for a free account at [ngrok](https://ngrok.com/) and install the ngrok package.
-Configure a Static Domain for your ngrok account and update the [.env](services/liquid-auth-api-js/README.md) file with the following keys with the values from ngrok:
-
-
-#### Configure NGROK
-
-```bash
-cp ./ngrok.template.yml ngrok.yml
-```
-
-Make sure to update the `authtoken` and `domain` in the `ngrok.yml` file with your ngrok details.
-
-```yaml
-version: 2
-authtoken: <NGROK_AUTH_TOKEN>
-tunnels:
-  website:
-    addr: liquid-demo:5173
-    proto: https
-    domain: <NGROK_STATIC_DOMAIN>
-```
-
-#### Update the Service's .docker.env file
-
-```bash
-#.docker.env
-HOSTNAME=<NGROK_STATIC_DOMAIN>
-ORIGIN=https://<NGROK_STATIC_DOMAIN>
-```
-
-#### Start services
-
-Run the following command to start the backend:
-
-```bash
-docker-compose up -d
-```
-
-Navigate to the ngrok URL in your browser to test the FIDO2 feature.
-
diff --git a/README.md b/README.md
index ab043da..6b92382 100644
--- a/README.md
+++ b/README.md
@@ -11,8 +11,6 @@ This project holds the standard FIDO2 api endpoints and the Proof of Knowledge f
 The api is a stateful session-based architecture with endpoint guards. 
 A user must prove ownership of a private key to associate PublicKeyCredentials
 
-
-
 ## Getting started
 
 ### Prerequisites
@@ -27,16 +25,6 @@ git clone git@github.com:algorandfoundation/liquid-auth.git && cd liquid-auth
 
 #### Install package dependencies
 
-```bash
-npm install
-```
-
-#### Build Dependencies
-
-```bash
-npm run build
-```
-
 WebAuthn requires a secure context (HTTPS) to work and this will not allow you to test the FIDO2 feature in your local machine.
 
 ### NGROK
@@ -47,12 +35,9 @@ Configure a Static Domain for your ngrok account and update the [.env](services/
 
 #### Configure NGROK
 
-```bash
-cp ./ngrok.template.yml ngrok.yml
-```
-
-Make sure to update the `authtoken` and `domain` in the `ngrok.yml` file with your ngrok details.
+Add a `ngrok.yml` configuration to the root directory.
 
+##### Example Configuration
 ```yaml
 version: 2
 authtoken: <NGROK_AUTH_TOKEN>
@@ -63,6 +48,7 @@ tunnels:
     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 .docker.env file
 
@@ -71,7 +57,7 @@ HOSTNAME=<NGROK_STATIC_DOMAIN>
 ORIGIN=https://<NGROK_STATIC_DOMAIN>
 ```
 
-#### Start services
+### Start services
 
 Run the following command to start the backend:
 
@@ -84,7 +70,7 @@ Navigate to the ngrok URL in your browser to test the FIDO2 feature.
 
 ## Using the app
 
-#### Install the [Android client]() to your device and navigate to https://nest-fido2.onrender.com/.
+#### Install the [Android client](https://github.com/awesome-algorand/android-authentication-client) to your device.
 
 ![Step-1.png](.docs%2FStep-1.png)
 
diff --git a/docker-compose.developer.yml b/docker-compose.developer.yml
deleted file mode 100644
index 83237e8..0000000
--- a/docker-compose.developer.yml
+++ /dev/null
@@ -1,10 +0,0 @@
-version: '3.4'
-
-services:
-  liquid-auth:
-    build: .
-    restart: always
-    env_file:
-      - .env.docker
-    ports:
-      - "3000:3000"
diff --git a/ngrok.template.yml b/ngrok.template.yml
deleted file mode 100644
index 6e09789..0000000
--- a/ngrok.template.yml
+++ /dev/null
@@ -1,7 +0,0 @@
-version: 2
-authtoken: <NGROK_AUTH_TOKEN>
-tunnels:
-  website:
-    addr: liquid-demo:5173
-    proto: https
-    domain: <NGROK_STATIC_DOMAIN>