riu-rd commited on
Commit
b95104f
·
verified ·
1 Parent(s): f6c138c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +28 -1
README.md CHANGED
@@ -13,6 +13,10 @@ short_description: Contact Center Operation Insights
13
 
14
  A FastAPI application for contact center operation insights and analytics.
15
 
 
 
 
 
16
  ## Local Development Setup
17
 
18
  Follow these steps to run the FastAPI application locally on your machine.
@@ -21,6 +25,23 @@ Follow these steps to run the FastAPI application locally on your machine.
21
 
22
  - Python 3.11
23
  - Git
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
24
 
25
  ### Installation
26
 
@@ -48,7 +69,13 @@ Follow these steps to run the FastAPI application locally on your machine.
48
  pip install -r requirements.txt
49
  ```
50
 
51
- 4. **Run the application**
 
 
 
 
 
 
52
  ```bash
53
  python api.py
54
  ```
 
13
 
14
  A FastAPI application for contact center operation insights and analytics.
15
 
16
+ ## System Requirements
17
+
18
+ This application requires FFmpeg for audio processing capabilities.
19
+
20
  ## Local Development Setup
21
 
22
  Follow these steps to run the FastAPI application locally on your machine.
 
25
 
26
  - Python 3.11
27
  - Git
28
+ - FFmpeg (for audio processing)
29
+
30
+ ### Installing FFmpeg
31
+
32
+ **On Ubuntu/Debian:**
33
+ ```bash
34
+ sudo apt-get update
35
+ sudo apt-get install ffmpeg
36
+ ```
37
+
38
+ **On macOS:**
39
+ ```bash
40
+ brew install ffmpeg
41
+ ```
42
+
43
+ **On Windows:**
44
+ Download from [FFmpeg official site](https://ffmpeg.org/download.html) and add to PATH.
45
 
46
  ### Installation
47
 
 
69
  pip install -r requirements.txt
70
  ```
71
 
72
+ 4. **Set up environment variables**
73
+ Create a `.env` file in the backend directory:
74
+ ```bash
75
+ GEMINI_API_KEY=your_api_key_here
76
+ ```
77
+
78
+ 5. **Run the application**
79
  ```bash
80
  python api.py
81
  ```