Plaudio is a little PWA which is developed for the project Gardeners Green Thumb. It should help gardeners document their work and make the data reachable for the scientist in the project.

With Plaudio the gardeners can use their phones to record audio locally and then upload it later to a provided Nextcloud.

• Step 1: Docker-Desktop

  Download and install Docker(-Desktop): https://www.docker.com/products/docker-desktop

• Step 2: Generate Private and Public Keys

  For this you can use a website like this: https://travistidwell.com/jsencrypt/demo/

• Step 3: Using the keys

  Copy the private key into a file called "private.key" inside of the "docker" folder.

  Copy the public key into a file called "public.key" inside of the "docker" folder. Also paste it into the "pubKey"-variable inside the "environment.prod.ts" which is inside the "client/src/environments" folder.

• Step 4: Update the server url

  In the aformentioned "environment.prod.ts", fill in the url of the server which can be reached by the frontend (something like "http://localhost" or "https://example.com").

• Step 5: Build the client

  Execute "ng build --prod" inside the client folder.

• Step 6: Update docker-compose

  Fill in the nextcloud related user and server information.

• Step 7: Run docker-compose

  Execute "docker-compose up --build" inside the "docker" folder. You should be up and running now. There are two test users. One of which is the user "test" with the password "test".

• Step 1: Shell

  Open a shell inside the docker folder.

• Step 2: Go into the container

  Execute "docker-compose exec api /bin/bash". You now have a bash shell inside of the container.

• Step 3: Manage users

  Execute "node registerUsers.js". Follow the steps on the screen.

• Step 4: Exit the Shell

  Execute "exit".

• Step 1: Preparations

  If not Done yet, follow all Steps in "How do I get set up for production?". After that stop Docker. (Strg + C in the Console where Docker is running)

• Step 2: Update the Server URL

  In the aformentioned "environment.ts", fill in the url of the server which can be reached by the frontend (something like "http://localhost" or "https://example.com").

• Step 3: Start Docker

  Execute "docker-compose up --build" inside the "docker" folder.

• Step 4: Start ng serve

  If not Done yet, execute "npm i" in the "client" folder. Execute "ng serve" in the "client" folder. Now you can visit the Website in a Webbrowser. (Normally it can be visited at "localhost:4200")

  Warning: Because of "docker-compose up --build" there is another Website running at "localhost".

• Step 1: build production dist

  in client execute "ng build --prod

• Step 2: start http-server

  in \client\dist"EXAMPLE" execute "http-server -p 4200 -c-1"

• Step 3: visit Page

  visit localhost:4200. Your Website should be shown.

• Step 4: check if Service Worker is working

  Press f12 and go to "Network". There should be a column, filled with "service-worker". If not Reload the site. If the reloading didn't showed "service-worker" in any Columns, then check if you build and started the App properly (look in Step 1 and 2).

Dmitrij Poberej

• Base features
• Audio Recording
• Audio Management
• Connection to NextCloud
• Offline Function

Jan Sonntag

• User Authentication
• User Management
• Client offline Verification
• UI improvements
• Translations

This project may include some private RSA keys or passwords that where used for development. These are just for testing and will not be used in production.