Spaces:
Running
Running
update README
Browse files
README.md
CHANGED
|
@@ -25,14 +25,31 @@ An application to explore and discover all leaderboards from the Hugging Face co
|
|
| 25 |
- 🌓 Dark/Light mode
|
| 26 |
- 🔄 Automatic data updates
|
| 27 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 28 |
## Local Development
|
| 29 |
|
| 30 |
1. Install client dependencies:
|
| 31 |
|
| 32 |
```bash
|
| 33 |
cd client
|
| 34 |
-
|
| 35 |
-
|
| 36 |
```
|
| 37 |
|
| 38 |
2. Install server dependencies:
|
|
@@ -46,3 +63,5 @@ poetry run dev
|
|
| 46 |
## Deployment
|
| 47 |
|
| 48 |
The application is configured to be deployed on a Hugging Face Space using Docker.
|
|
|
|
|
|
|
|
|
| 25 |
- 🌓 Dark/Light mode
|
| 26 |
- 🔄 Automatic data updates
|
| 27 |
|
| 28 |
+
## Configuration
|
| 29 |
+
|
| 30 |
+
### Environment Variables
|
| 31 |
+
|
| 32 |
+
Create a `.env` file in the server directory with the following variables:
|
| 33 |
+
|
| 34 |
+
```bash
|
| 35 |
+
# Hugging Face API token (required)
|
| 36 |
+
HF_TOKEN=your_token_here
|
| 37 |
+
|
| 38 |
+
# Server configuration (optional)
|
| 39 |
+
API_HOST=0.0.0.0
|
| 40 |
+
API_PORT=3002
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
The `HF_TOKEN` is required to access private datasets on Hugging Face. You can get your token from your [Hugging Face account settings](https://huggingface.co/settings/tokens).
|
| 44 |
+
|
| 45 |
## Local Development
|
| 46 |
|
| 47 |
1. Install client dependencies:
|
| 48 |
|
| 49 |
```bash
|
| 50 |
cd client
|
| 51 |
+
npm install
|
| 52 |
+
npm run dev
|
| 53 |
```
|
| 54 |
|
| 55 |
2. Install server dependencies:
|
|
|
|
| 63 |
## Deployment
|
| 64 |
|
| 65 |
The application is configured to be deployed on a Hugging Face Space using Docker.
|
| 66 |
+
|
| 67 |
+
When deploying, make sure to set the `HF_TOKEN` as a secret in your deployment environment.
|