github-hf-sync / README.md
amirkiarafiei's picture
Update medium article link
2689589
---
title: Github and Hugging Face Space Synchronization
emoji: 🤝
colorFrom: indigo
colorTo: blue
sdk: docker
pinned: false
short_description: 'A Sample Space Synced with a GitHub Repository '
---
# Github and Hugging Face Synchronization
This project shows you how to develop your app in GitHub and automatically sync it to a Hugging Face Space to host it online. For a detailed step-by-step guide with pictures, check out our [Medium article](https://medium.com/@amirkiarafiei/github-repository-hugging-face-space-synchronization-step-by-step-guide-a6c79cc5d3c5). Let’s get your app live easily!.
---
### Requirements
- `Python 3.9`
- `pip install -r requirements.txt`
---
### How to send a GET request to the Hugging Face Space endpoint
The Hugging Face Space endpoint of this project is `https://amirkiarafiei-github-hf-sync.hf.space/`.
You can either:
- Send a curl request in your terminal:
```bash
curl -s GET https://amirkiarafiei-github-hf-sync.hf.space/
```
- Or run the `main.py`:
```bash
python main.py
```