machineuser commited on
Commit
790ed2e
1 Parent(s): 0757360

Sync widgets demo

Browse files
Files changed (1) hide show
  1. packages/widgets/README.md +21 -1
packages/widgets/README.md CHANGED
@@ -16,7 +16,14 @@ You can run the demo locally:
16
 
17
  ```console
18
  pnpm install
19
- pnpm dev
 
 
 
 
 
 
 
20
  ```
21
 
22
  If you want to try the "Sign-in with HF" feature locally, you will need to https://huggingface.co/settings/applications/new an OAuth application with `"openid"`, `"profile"` and `"inference-api"` scopes and `http://localhost:5173/auth/callback/huggingface` as the redirect URL.
@@ -29,3 +36,16 @@ OAUTH_CLIENT_SECRET=...
29
  ```
30
 
31
  If you want to try the "Sign-in with HF" feature in a Space, you can just duplicate https://huggingface.co/spaces/huggingfacejs/inference-widgets, it should work out of the box thanks to the metadata in the `README.md` file.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
 
17
  ```console
18
  pnpm install
19
+ pnpm dev --open
20
+ ```
21
+
22
+ If you are submitting a PR, make sure that you run `format` & `lint` before submitting the PR:
23
+
24
+ ```console
25
+ pnpm format
26
+ pnpm lint
27
  ```
28
 
29
  If you want to try the "Sign-in with HF" feature locally, you will need to https://huggingface.co/settings/applications/new an OAuth application with `"openid"`, `"profile"` and `"inference-api"` scopes and `http://localhost:5173/auth/callback/huggingface` as the redirect URL.
 
36
  ```
37
 
38
  If you want to try the "Sign-in with HF" feature in a Space, you can just duplicate https://huggingface.co/spaces/huggingfacejs/inference-widgets, it should work out of the box thanks to the metadata in the `README.md` file.
39
+
40
+ ## Testing for moon (for huggingface admins)
41
+
42
+ ```console
43
+ pnpm i
44
+ pnpm build
45
+ ```
46
+
47
+ And then inside moon, run the following command for both `server` & `front`:
48
+
49
+ ```console
50
+ npm i --save @huggingface/widgets@<relative path to huggingface.js/packages/widgets>
51
+ ```