From 2847ee177b468f14be6314c3570903be2706e9ce Mon Sep 17 00:00:00 2001 From: Sara Date: Wed, 1 Nov 2023 12:43:51 +0100 Subject: [PATCH] fix readme and env files --- README.md | 26 +++++++++++++++++++++++--- www/.env_template | 5 +++++ 2 files changed, 28 insertions(+), 3 deletions(-) create mode 100644 www/.env_template diff --git a/README.md b/README.md index 3e8bd5e1..22651cc6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Reflector -Reflector is a cutting-edge web application under development by Monadical. It utilizes AI to record meetings, providing a permanent record with transcripts, translations, and automated summaries. +Reflector Audio Management and Analysis is a cutting-edge web application under development by Monadical. It utilizes AI to record meetings, providing a permanent record with transcripts, translations, and automated summaries. The project architecture consists of three primary components: @@ -8,6 +8,8 @@ The project architecture consists of three primary components: * **Back-End**: Python server that offers an API and data persistence, found in `server/`. * **AI Models**: Providing services such as speech-to-text transcription, topic generation, automated summaries, and translations. +It also uses https://github.com/fief-dev for authentication, and Vercel for deployment and configuration of the front-end. + ## Table of Contents - [Reflector](#reflector) @@ -31,12 +33,18 @@ The project architecture consists of three primary components: ### Contribution Guidelines -All new contributions should be made in a separate branch. Before any code is merged into `master`, it requires a code review. +All new contributions should be made in a separate branch. Before any code is merged into `main`, it requires a code review. ### How to Install Blackhole (Mac Only) +To record both your voice and the meeting you're taking part in, you need : +- For an in-person meeting, make sure your microphone is in range of all participants. +- If using several miscrophones, make sure to merge the audio feeds into one with an external tool. +- For an online meeting, if you do not use headphones, your microphone should be able to pick up both your voice and the audio feed of the meeting. +- If you want to use headphones, you need to merge the audio feeds with an external tool. + +This is an external tool for merging the audio feeds as explained in the previous section of this document. Note: We currently do not have instructions for Windows users. - * Install [Blackhole](https://github.com/ExistentialAudio/BlackHole)-2ch (2 ch is enough) by 1 of 2 options listed. * Setup ["Aggregate device"](https://github.com/ExistentialAudio/BlackHole/wiki/Aggregate-Device) to route web audio and local microphone input. * Setup [Multi-Output device](https://github.com/ExistentialAudio/BlackHole/wiki/Multi-Output-Device) @@ -60,6 +68,15 @@ To install the application, run: ```bash yarn install ``` +Then create an `.env` with: + +``` +FIEF_URL=https://auth.reflector-ui.dev/reflector-local +FIEF_CLIENT_ID=s03 +FIEF_CLIENT_SECRET= + +EDGE_CONFIG= +``` ### Run the Application @@ -108,6 +125,9 @@ AUTH_BACKEND=fief AUTH_FIEF_URL=https://auth.reflector.media/reflector-local AUTH_FIEF_CLIENT_ID=KQzRsNgoY AUTH_FIEF_CLIENT_SECRET= + +TRANSLATE_URL=https://monadical-sas--reflector-translator-web.modal.run +ZEPHYR_LLM_URL=https://monadical-sas--reflector-llm-zephyr-web.modal.run ``` ### Start the project diff --git a/www/.env_template b/www/.env_template new file mode 100644 index 00000000..1d3d2390 --- /dev/null +++ b/www/.env_template @@ -0,0 +1,5 @@ +FIEF_URL=https://auth.reflector-ui.dev/reflector-local +FIEF_CLIENT_ID=s03 +FIEF_CLIENT_SECRET= + +EDGE_CONFIG= \ No newline at end of file