Abdullah Khaled commited on
Commit
1f115a9
·
unverified ·
1 Parent(s): 6c7da6d

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +72 -1
README.md CHANGED
@@ -24,6 +24,77 @@ The AI Voice Secretary is a sophisticated virtual assistant designed to provide
24
  - **WebSocket Communication**: Enables real-time audio and text interaction between the frontend and backend.
25
  - **Responsive UI**: Built with React and styled with Tailwind CSS for a modern and user-friendly interface.
26
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
27
  ## How It Works
28
 
29
  The AI Voice Secretary integrates multiple components to process user queries and deliver responses:
@@ -231,4 +302,4 @@ cd ai-voice-secretary
231
 
232
  ## License
233
 
234
- This project is licensed under the MIT License. See the LICENSE file for details.
 
24
  - **WebSocket Communication**: Enables real-time audio and text interaction between the frontend and backend.
25
  - **Responsive UI**: Built with React and styled with Tailwind CSS for a modern and user-friendly interface.
26
 
27
+
28
+ ## Step by step on how to make your own one:
29
+
30
+ - Fork the repo
31
+
32
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/forking_1.png)
33
+
34
+
35
+ - After creating your huggingface account (https://huggingface.co/) go to profile and get the HF_TOKEN (Create new one and save the value)
36
+
37
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/HF_Token_1.png?raw=true)
38
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/HF_Token_2.png)
39
+
40
+
41
+ - Add the huggingface token here with the name of HF_TOKEN
42
+
43
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/forking_2.png?raw=true)
44
+
45
+
46
+
47
+ - Go to my space and duplicate it (https://huggingface.co/spaces/abdullah-khaled/ai-voice-secretary/tree/main)
48
+
49
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_space_1.png?raw=true)
50
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_space_2.png?raw=true)
51
+
52
+
53
+ - To get the github token and Google api
54
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/getting_github_token.png?raw=true)
55
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/getting_gemini_key.png?raw=true)
56
+
57
+
58
+
59
+ - Now update the values based on your personal data (Important: update these values on github repo not huggingface repo)
60
+ - Note: you will get the value of Vercel URL after finishing this, and don't forget to change it after the creation
61
+
62
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_space_3.png?raw=true)
63
+
64
+
65
+ - And go to this file and update the specified values (the space name and your username are above beside your profile picture)
66
+
67
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_space_4.png?raw=true)
68
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_space_5.png?raw=true)
69
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_space_6.png?raw=true)
70
+
71
+
72
+
73
+ - Then go to this file and change these values based on yours
74
+
75
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_space_7.png?raw=true)
76
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/github_link.png?raw=true)
77
+
78
+
79
+
80
+ - Go the main.yaml in workflow and change these values based on yours
81
+
82
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/forking_3.png?raw=true)
83
+
84
+
85
+ - Now its time to create the frontend (vercel)
86
+
87
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_vercel_1.png)
88
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_vercel_2.png)
89
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_vercel_3.png)
90
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_vercel_4.png)
91
+
92
+
93
+
94
+ - Finally change this Vercel URL
95
+
96
+ ![Image](https://github.com/abdullah0150/Images/blob/main/AI_Voice_Images/setup_space_3.png?raw=true)
97
+
98
  ## How It Works
99
 
100
  The AI Voice Secretary integrates multiple components to process user queries and deliver responses:
 
302
 
303
  ## License
304
 
305
+ This project is licensed under the MIT License. See the LICENSE file for details.