Technical installation manual

Introduction

Our project is developed for android and IOS and hence there is potential for cross platform development

Prerequisites

Any computer that can run android studio will be able to run the emulator for our app. Additionally the app can be run on an android device.

Installation

Frontend

The following is required:

• Node.js - https://nodejs.org/en/
• React Native - https://reactnative.dev/docs/environment-setup (follow the React Native CLI QuickStart steps)

Backend

The following needs to be installed (A list of all dependencies can be found in the root package.json. They can be installed by running 'yarn') :

• Yarn - npm install yarn
• Nx - npm install nx
• Python(v3.9)
• Docker v20.10.17 (not required if you don’t use docker for running the app)

Python

The following python modules is required to run the different python scripts:

• flask
• flask-cors
• requests
• pandas
• bs4
• tensorflow
• nltk
• azure-cognitive-speech

Deployment/Running

There are two approaches to run the backend:

• Build and start the docker containers based on their configured images.
• Run ‘yarn start run api’ and run all the python services (xxx-server.py)

The following ports are exposed when running the app:

• 3333: Is used by graphql api (which includes all code under api and service for each service)
• 5000: Is used by the summarise-text-server.py(Located in huggingface for the summariser service)
• 5050: Is used by the speech-to-text-server.py(Located in deepspeech for the speech to text service)
• 5550: Is used by the generate-names-server.py(Located in AI in the generate names service)
• 5555: Is used by the embed-text-server.py (Located in semantic-search for the pdf manager service)

Link to User Manual: https://github.com/COS301-SE-2022/Conversation-Catcher/wiki/User-Manual