Papad User guide

• Papad User guide
  • About
    • Usecase
  • Installation
    • Dependencies
    • Services
  • Usage
  • Develop

About

Papad is developed to be deployed on Aspi evices in the context of mesh network. For demo purposes we have deployed online version at https://papad.test.openrun.net/home

Usecase

Aspi Devices = d1, d2, d3…
Wifi Mesh Nodes = n1, n2, n3…

Say, device d1 is connected to node n1, d2 to n2 and so on spread across a local area that qualifies to be mesh network.

• user u1 connects to device d1 and records a audio message, asking for collaborators to join for producing decorative materials for a local wedding.
• Audio is uploaded to papad and tagged.
• The annotated tags is federated across the local mesh, which means all the devices in the network will receive the audio and the annotations
• User u2 is a crafts person, connected to device d2 via node n2 and sees the annotation, listens to the audio and adds a comment about their interest in collaborating, also adding pictures of their work to a section of the audio.
• Thats a matched gig!

Installation

Multiple services are used in the functioning of the Papad App. Below is the list of those services and instructions to install on Raspberry pi 4 or local server.

Dependencies

One of the easiest ways to deploy is to use docker and docker-compose

• Docker
• Docker Compose
  Follow steps from this tutorial to install docker and docker-compose in your raspberry pi https://dev.to/elalemanyo/how-to-install-docker-and-docker-compose-on-raspberry-pi-1mo

Services

1. Syncthing: Is a File synchronization service. Follow instructions here to run syncthing locally https://hub.docker.com/r/linuxserver/syncthing
2. Papad Api: Is the Annotation server, that creates and manages the annotations. Follow instructions here to run the api server on docker https://github.com/janastu/papad-api/#docker
3. Papad frontend: This is the Angular frontend application, which implements the UI/UX for Papad app.

git clone [e-mail]:servelots/slots/papad.git
cd papad
vi docker-compose.yml (edit the virtual host and port config)
docker-compose up -d
(your app will running at the configured port)

Usage

After installing open the url in your browser.
There are 3 screens, Ingest, Annotate, Connections

1. Ingest: This screen is integrated with the Syncthing service, to access the files. You will see the folders from your syncthing default folder. At this time the UI can only browse through one level of folder, and this is work in progress, changing in future.

2. Annotate: Here you can browse the ingested files, Filter by Tags and channels, and click on a single card, where you can listen to audio and add annotations to specific sections of an audio.

3. Connections: Is a visual map of all content in a single installation

Develop

To contribute to this project, contact us