Spaces:
Running
Running
Update README.md
Browse files
README.md
CHANGED
|
@@ -8,4 +8,60 @@ app_file: dist/index.html
|
|
| 8 |
pinned: false
|
| 9 |
---
|
| 10 |
|
| 11 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 8 |
pinned: false
|
| 9 |
---
|
| 10 |
|
| 11 |
+
## Development Guide when using React frontend
|
| 12 |
+
|
| 13 |
+
### 1️⃣ Prerequisites
|
| 14 |
+
|
| 15 |
+
Make sure you have **Node.js** installed.
|
| 16 |
+
|
| 17 |
+
You can check with:
|
| 18 |
+
|
| 19 |
+
```bash
|
| 20 |
+
node -v
|
| 21 |
+
npm -v
|
| 22 |
+
```
|
| 23 |
+
|
| 24 |
+
---
|
| 25 |
+
|
| 26 |
+
### 2️⃣ Install Dependencies (First Time Only)
|
| 27 |
+
|
| 28 |
+
```bash
|
| 29 |
+
npm install
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
This installs all required packages listed in `package.json`.
|
| 33 |
+
|
| 34 |
+
---
|
| 35 |
+
|
| 36 |
+
### 3️⃣ Run Locally (Development Mode)
|
| 37 |
+
|
| 38 |
+
```bash
|
| 39 |
+
npm run dev
|
| 40 |
+
```
|
| 41 |
+
|
| 42 |
+
- Starts the local development server
|
| 43 |
+
- Automatically reloads when files are edited
|
| 44 |
+
|
| 45 |
+
---
|
| 46 |
+
|
| 47 |
+
### 4️⃣ Deploy to Hugging Face
|
| 48 |
+
|
| 49 |
+
#### Build the production version:
|
| 50 |
+
|
| 51 |
+
```bash
|
| 52 |
+
npm run build
|
| 53 |
+
```
|
| 54 |
+
|
| 55 |
+
This generates the production build inside the `dist/` directory.
|
| 56 |
+
|
| 57 |
+
#### Commit and push:
|
| 58 |
+
|
| 59 |
+
```bash
|
| 60 |
+
git add <files>
|
| 61 |
+
git commit
|
| 62 |
+
git push
|
| 63 |
+
```
|
| 64 |
+
|
| 65 |
+
⚠️ Make sure the `dist/` directory is included when adding to git.
|
| 66 |
+
⚠️ Even if you only changed the backend, you must still run `npm run build` when deploying or it will not update.
|
| 67 |
+
|