Skip to content

Commit 5234914

Browse files
committed
Add GitHub repository reference to Hugging Face Space
- Add repo field to Hugging Face Space metadata in README - Add prominent GitHub repository link in README header - Add Project Links section showing all platform connections - Add GitHub Integration note to CI/CD section - Add Deployment Flow showing GitHub to Hugging Face connection - Ensure Hugging Face Space references GitHub repository
1 parent 2233a48 commit 5234914

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ python_version: "3.10"
99
app_file: app.py
1010
pinned: false
1111
license: mit
12+
repo: https://github.com/nellaivijay/research-assistant
1213
---
1314

1415
# 📚 Enhanced Research Assistant - AI Model Selection
@@ -20,6 +21,8 @@ license: mit
2021

2122
**🚀 Live Application:** [https://huggingface.co/spaces/nellaivijay/research-assistant](https://huggingface.co/spaces/nellaivijay/research-assistant)
2223

24+
**📦 GitHub Repository:** [https://github.com/nellaivijay/research-assistant](https://github.com/nellaivijay/research-assistant)
25+
2326
AI-powered research companion with custom AI model selection, multi-source recommendations, analysis, and workflow management. An enhanced version of paper recommendation systems with comprehensive research workflow features and optional AI-powered analysis.
2427

2528
## 🏷️ Repository Topics
@@ -58,6 +61,17 @@ AI-powered research companion with custom AI model selection, multi-source recom
5861
- `knowledge-management`
5962
- `document-analysis`
6063

64+
## 🔗 Project Links
65+
66+
This project is deployed on multiple platforms for different purposes:
67+
68+
| Platform | URL | Purpose |
69+
|----------|-----|---------|
70+
| **🚀 Hugging Face Space** | [https://huggingface.co/spaces/nellaivijay/research-assistant](https://huggingface.co/spaces/nellaivijay/research-assistant) | Live application deployment |
71+
| **📦 GitHub Repository** | [https://github.com/nellaivijay/research-assistant](https://github.com/nellaivijay/research-assistant) | Source code and development |
72+
| **📚 GitHub Pages** | [https://nellaivijay.github.io/research-assistant](https://nellaivijay.github.io/research-assistant) | Documentation website |
73+
| **📖 GitHub Wiki** | [https://github.com/nellaivijay/research-assistant/wiki](https://github.com/nellaivijay/research-assistant/wiki) | Comprehensive documentation |
74+
6175
## 🎓 Educational Purpose
6276

6377
This project is created for **educational purposes only** to demonstrate:
@@ -282,6 +296,14 @@ This project uses GitHub Actions for automated CI/CD pipeline:
282296
- **Continuous Integration**: Tests run on every push and pull request
283297
- **Automated Deployment**: Auto-deploys to Hugging Face Spaces on successful tests
284298
- **Security Scanning**: Checks for hardcoded credentials and security issues
299+
- **GitHub Integration**: Hugging Face Space is linked to GitHub repository for seamless deployment
300+
301+
### Deployment Flow
302+
1. Code changes pushed to GitHub repository
303+
2. GitHub Actions CI/CD pipeline triggers
304+
3. Automated testing and security scanning
305+
4. If tests pass, automatic deployment to Hugging Face Spaces
306+
5. Live application updated at https://huggingface.co/spaces/nellaivijay/research-assistant
285307

286308
For detailed GitHub setup instructions, see [GITHUB_SETUP.md](GITHUB_SETUP.md)
287309

0 commit comments

Comments
 (0)