Spaces:
Sleeping
Sleeping
Commit
Β·
0fcf895
1
Parent(s):
5a6fe47
update README
Browse files
README.md
CHANGED
@@ -217,22 +217,7 @@ cd ai-voice-secretary
|
|
217 |
- **Contact Info**: "How can I contact Abdullah?"
|
218 |
- **Platform Links**: "What is Abdullah's LinkedIn profile?"
|
219 |
|
220 |
-
## Project Structure
|
221 |
|
222 |
-
```
|
223 |
-
ai-voice-secretary/
|
224 |
-
βββ src/
|
225 |
-
β βββ backend/
|
226 |
-
β β βββ voice_assistant.py # FastAPI backend with RAG, STT, and TTS
|
227 |
-
β β βββ requirements.txt # Backend dependencies
|
228 |
-
β β βββ .env # Environment variables (not committed)
|
229 |
-
β βββ frontend/
|
230 |
-
β β βββ src/ # React source code
|
231 |
-
β β βββ package.json # Frontend dependencies
|
232 |
-
β β βββ vite.config.js # Vite configuration
|
233 |
-
βββ Dockerfile # Docker configuration for backend
|
234 |
-
βββ README.md # Project documentation
|
235 |
-
```
|
236 |
|
237 |
## Notes
|
238 |
|
@@ -242,15 +227,7 @@ ai-voice-secretary/
|
|
242 |
- **HuggingFace Spaces**: Monitor resource usage on HuggingFace Spaces, as heavy computations (e.g., LLM inference) may require a paid plan.
|
243 |
- **Vercel Deployment**: Configure Vercel to handle environment variables for the frontend if needed.
|
244 |
|
245 |
-
## Contributing
|
246 |
-
|
247 |
-
Contributions are welcome! Please:
|
248 |
|
249 |
-
1. Fork the repository.
|
250 |
-
2. Create a feature branch (`git checkout -b feature/your-feature`).
|
251 |
-
3. Commit changes (`git commit -m "Add your feature"`).
|
252 |
-
4. Push to the branch (`git push origin feature/your-feature`).
|
253 |
-
5. Open a pull request.
|
254 |
|
255 |
## License
|
256 |
|
|
|
217 |
- **Contact Info**: "How can I contact Abdullah?"
|
218 |
- **Platform Links**: "What is Abdullah's LinkedIn profile?"
|
219 |
|
|
|
220 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
221 |
|
222 |
## Notes
|
223 |
|
|
|
227 |
- **HuggingFace Spaces**: Monitor resource usage on HuggingFace Spaces, as heavy computations (e.g., LLM inference) may require a paid plan.
|
228 |
- **Vercel Deployment**: Configure Vercel to handle environment variables for the frontend if needed.
|
229 |
|
|
|
|
|
|
|
230 |
|
|
|
|
|
|
|
|
|
|
|
231 |
|
232 |
## License
|
233 |
|