Skip to content

Commit

Permalink
Updated README with workaround for tinylicious error (#604)
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanbliss authored May 23, 2023
1 parent 8df4bdf commit a438384
Show file tree
Hide file tree
Showing 30 changed files with 81 additions and 53 deletions.
1 change: 0 additions & 1 deletion samples/javascript/01.dice-roller/.npmrc

This file was deleted.

1 change: 0 additions & 1 deletion samples/javascript/01.dice-roller/.nvmrc

This file was deleted.

17 changes: 3 additions & 14 deletions samples/javascript/01.dice-roller/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,12 @@ After cloning the repository, you must first set up the npm workspace from the r
npm install
npm run build:packages # Build Live Share packages
cd samples/j*/01*
npm start
```

_Note:_ Do not run `npm start` before running `npm run build:packages` from the root of the project, unless you first move the sample out of this npm workspace. When using our samples, you are testing the packages using symlinks, and not the Live Share SDK versions published to npm.

## Testing locally in browser

### `npm run start`
Running `npm start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.
You can copy this URL and paste it into new browser tabs to test Live Share using a local server.
To test the side panel & video queue, you can replace your URL with `/sidepanel#{id}`.

**Note:** if testing with HTTPS, such as when using a tunneling service like Ngrok, instead use the command `npm run start-https`.
_Note:_ Do not run `npm start` before running `npm run build:packages` from the root of the project, unless you first move the sample out of this npm workspace. When using our samples, you are testing the packages using symlinks, and not the Live Share SDK versions published to npm.

## Testing the app in Teams

Expand Down
1 change: 0 additions & 1 deletion samples/javascript/02.react-video/.npmrc

This file was deleted.

14 changes: 10 additions & 4 deletions samples/javascript/02.react-video/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,18 @@ _Note:_ Do not run `npm start` before running `npm run build:packages` from the

### `npm run start`

Runs the app in the development mode.\
Runs the app in the development mode.

Running `npm run start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.\
You can copy this URL and paste it into new browser tabs to test Live Share using a local server.\
The page will reload when you make changes.

Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.

You can copy this URL and paste it into new browser tabs to test Live Share using a local server.

To test the side panel & video queue, you can replace your URL with `/sidepanel#{id}`.

**Note:** if testing with HTTPS, such as when using a tunneling service like Ngrok, instead use the command `npm run start-https`.
Expand Down
1 change: 0 additions & 1 deletion samples/javascript/03.live-canvas-demo/.npmrc

This file was deleted.

13 changes: 9 additions & 4 deletions samples/javascript/03.live-canvas-demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,17 @@ _Note:_ Do not run `npm start` before running `npm run build:packages` from the

### `npm run start`

Runs the app in the development mode.\
Runs the app in the development mode.

Running `npm run start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.\
You can copy this URL and paste it into new browser tabs to test Live Share using a local server.\
The page will reload when you make changes.

Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.

You can copy this URL and paste it into new browser tabs to test Live Share using a local server.

## Testing the app in Teams

Expand Down
1 change: 0 additions & 1 deletion samples/javascript/04.live-share-react/.npmrc

This file was deleted.

10 changes: 8 additions & 2 deletions samples/javascript/04.live-share-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,18 @@ _Note:_ Do not run `npm start` before running `npm run build:packages` from the

### `npm run start`

Runs the app in the development mode.\
Runs the app in the development mode.

Running `npm run start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
The page will reload when you make changes.

Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.

You can copy this URL and paste it into new browser tabs to test Live Share using a local server.

To test the side panel & video queue, you can replace your URL with `/sidepanel#{id}`.

**Note:** if testing with HTTPS, such as when using a tunneling service like Ngrok, instead use the command `npm run start-https`.
Expand Down
1 change: 0 additions & 1 deletion samples/javascript/05.dice-roller-turbo/.npmrc

This file was deleted.

1 change: 0 additions & 1 deletion samples/javascript/05.dice-roller-turbo/.nvmrc

This file was deleted.

10 changes: 8 additions & 2 deletions samples/javascript/05.dice-roller-turbo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,18 @@ _Note:_ Do not run `npm start` before running `npm run build:packages` from the

### `npm run start`

Runs the app in the development mode.\
Runs the app in the development mode.

Running `npm run start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
The page will reload when you make changes.

Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.

You can copy this URL and paste it into new browser tabs to test Live Share using a local server.

To test the side panel & video queue, you can replace your URL with `/sidepanel#{id}`.

**Note:** if testing with HTTPS, such as when using a tunneling service like Ngrok, instead use the command `npm run start-https`.
Expand Down
1 change: 0 additions & 1 deletion samples/javascript/21.react-media-template/.npmrc

This file was deleted.

2 changes: 2 additions & 0 deletions samples/javascript/21.react-media-template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ _Note:_ Do not run `npm start` before running `npm run build:packages` from the

Runs the app in the development mode.

Running `npm run start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.
Expand Down
1 change: 0 additions & 1 deletion samples/javascript/22.react-agile-poker/.npmrc

This file was deleted.

14 changes: 10 additions & 4 deletions samples/javascript/22.react-agile-poker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,18 @@ _Note:_ Do not run `npm start` before running `npm run build:packages` from the

### `npm run start`

Runs the app in the development mode.\
Runs the app in the development mode.

Running `npm run start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.\
You can copy this URL and paste it into new browser tabs to test Live Share using a local server.\
The page will reload when you make changes.

Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.

You can copy this URL and paste it into new browser tabs to test Live Share using a local server.

To test the side panel & video queue, you can replace your URL with `/sidepanel#{id}`.

**Note:** if testing with HTTPS, such as when using a tunneling service like Ngrok, instead use the command `npm run start-https`.
Expand Down
1 change: 0 additions & 1 deletion samples/javascript/23.react-live-canvas/.npmrc

This file was deleted.

11 changes: 8 additions & 3 deletions samples/javascript/23.react-live-canvas/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,17 @@ _Note:_ Do not run `npm start` before running `npm run build:packages` from the

### `npm run start`

Runs the app in the development mode.\
Runs the app in the development mode.

Running `npm start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.\
You can copy this URL and paste it into new browser tabs to test Live Share using a local server.\
Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.

You can copy this URL and paste it into new browser tabs to test Live Share using a local server.

To test the side panel & video queue, you can replace your URL with `/sidepanel#{id}`.

**Note:** if testing with HTTPS, such as when using a tunneling service like Ngrok, instead use the command `npm run start-https`.
Expand Down
1 change: 0 additions & 1 deletion samples/typescript/01.dice-roller/.npmrc

This file was deleted.

2 changes: 2 additions & 0 deletions samples/typescript/01.dice-roller/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ cd samples/t*/01*
npm start
```

Running `npm start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

_Note:_ Do not run `npm start` before running `npm run build:packages` from the root of the project, unless you first move the sample out of this npm workspace. When using our samples, you are testing the packages using symlinks, and not the Live Share SDK versions published to npm.

## Testing the app in Teams
Expand Down
1 change: 0 additions & 1 deletion samples/typescript/03.live-canvas-demo/.npmrc

This file was deleted.

5 changes: 5 additions & 0 deletions samples/typescript/03.live-canvas-demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,15 @@ _Note:_ Do not run `npm start` before running `npm run build:packages` from the
### `npm run start`

Runs the app in the development mode.

Running `npm run start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.

Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.

You can copy this URL and paste it into new browser tabs to test Live Share using a local server.

## Testing the app in Teams
Expand Down
1 change: 0 additions & 1 deletion samples/typescript/04.live-share-react/.npmrc

This file was deleted.

10 changes: 8 additions & 2 deletions samples/typescript/04.live-share-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,18 @@ _Note:_ Do not run `npm start` before running `npm run build:packages` from the

### `npm run start`

Runs the app in the development mode.\
Runs the app in the development mode.

Running `npm run start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
The page will reload when you make changes.

Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.

You can copy this URL and paste it into new browser tabs to test Live Share using a local server.

To test the side panel & video queue, you can replace your URL with `/sidepanel#{id}`.

**Note:** if testing with HTTPS, such as when using a tunneling service like Ngrok, instead use the command `npm run start-https`.
Expand Down
1 change: 0 additions & 1 deletion samples/typescript/05.dice-roller-turbo/.npmrc

This file was deleted.

1 change: 0 additions & 1 deletion samples/typescript/05.dice-roller-turbo/.nvmrc

This file was deleted.

5 changes: 5 additions & 0 deletions samples/typescript/05.dice-roller-turbo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,15 @@ _Note:_ Do not run `npm start` before running `npm run build:packages` from the
### `npm run start`

Runs the app in the development mode.

Running `npm run start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.

Upon loading, if there is no `/#{id}` in the URL, it will create one and insert it into the URL.

You can copy this URL and paste it into new browser tabs to test Live Share using a local server.

## Testing the app in Teams
Expand Down
1 change: 0 additions & 1 deletion samples/typescript/21.react-media-template/.npmrc

This file was deleted.

4 changes: 3 additions & 1 deletion samples/typescript/21.react-media-template/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ _Note:_ Do not run `npm start` before running `npm run build:packages` from the

### `npm run start`

Running `npm run start`, it will do two things: start the `tinylicious` server and start the application using `vite`. If you have never used `tinylicious` before, you should see instead is a prompt saying `Ok to proceed? (y)`, after which you should type `y` and press the "enter" key. In rare cases you might not see the `Ok to proceed? (y)` prompt, in which case try running `npx tinylicious@latest` in your command line directly, and then try again.

Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.
Expand All @@ -33,7 +35,7 @@ You can copy this URL and paste it into new browser tabs to test Live Share usin

To test the side panel & video queue, you can replace your URL with `/sidepanel#{id}`.

**Note:** if testing with HTTPS, such as when using a tunneling service like Ngrok, instead use the command `npm run start-https`.
_Note:_ if testing with HTTPS, such as when using a tunneling service like Ngrok, instead use the command `npm run start-https`.

### Known issues when testing in browser

Expand Down
1 change: 0 additions & 1 deletion samples/typescript/31.live-canvas-tests/.npmrc

This file was deleted.

0 comments on commit a438384

Please sign in to comment.