artydev commited on
Commit
3bd3bee
·
verified ·
1 Parent(s): 98a4123

Update Readme

Browse files
Files changed (1) hide show
  1. README.md +8 -29
README.md CHANGED
@@ -1,29 +1,8 @@
1
- # FastHTML on 🤗 Spaces
2
-
3
- Deploy a FastHTML application to [HuggingFace Spaces](https://huggingface.co/spaces) for free with one command!
4
-
5
- ## Quickstart
6
-
7
- 1. Create a free account on [HuggingFace](https://huggingface.co)
8
- 2. Go to your account settings and create an access token with write access. Keep this token safe and don't share it.
9
- 3. Set the `HF_TOKEN` environment variable to that token
10
- 4. Install fasthtml-hf: `pip install fasthtml-hf`
11
- 5. HuggingFace needs `fasthtml-hf` to run your space, so add it to your requirements.txt file.
12
- 6. At the top of your `main.py` add `from fasthtml_hf import setup_hf_backup`, and just before you run uvicorn add `setup_hf_backup(app)`
13
- 7. Run `fh_hf_deploy <space_name>`, replacing `<space_name>` with the name you want to give your space.
14
-
15
- By default this will upload a public space. You can make it private with `--private true`.
16
-
17
- ## Configuration
18
-
19
- The space will upload a backup of your database to a [HuggingFace Dataset](https://huggingface.co/datasets). By default it will be private and its name will be `<your-huggingface-id>/space-backup`. You can change this behavior in the `config.ini` file. In not provided, a default file will be created with the contents (note that the `[DEFAULT]` line is required at the top):
20
-
21
- ```
22
- [DEFAULT]
23
- dataset_id = space-backup
24
- db_dir = data
25
- private_backup = True
26
- interval = 15 # number of minutes between periodic backups
27
- ```
28
-
29
- If you so choose, you can disable the automatic backups and use [persistent storage](https://huggingface.co/docs/hub/en/spaces-storage#persistent-storage-specs) instead for $5/month (USD).
 
1
+ title: FastHTML
2
+ emoji: ⚡
3
+ colorFrom: green
4
+ colorTo: yellow
5
+ sdk: docker
6
+ pinned: false
7
+ license: apache-2.0
8
+ app_port: 5001