1- # Smelter demo application
1+ # Overview
22
33This application is built from 3 components:
44- Smelter server
5- - Node.js process that controls Smelter server.
5+ - Node.js process that controls the Smelter server.
66- Next.js app:
77 - Streams camera or screen share to Smelter over WHIP.
88 - Displays modified stream received from Smelter (broadcasted over WHEP)
99 - Controls video layout via HTTP API of the Node.js process.
1010
11- ## Usage
11+ # Usage
1212
13- ### Development
13+ ## Development
1414
15- #### Start Node.js server
15+ #### Step 1: Start Node.js server
1616
17- In ** ` ./server ` ** (in a separate terminal) run:
17+ In ** ` ./server ` ** run:
1818
1919``` sh
2020pnpm install && pnpm start
2121```
2222
2323Node.js server will automatically start a Smelter server and connect to it.
2424
25- #### Start Next.js app
25+ #### Step 2: Start Next.js app
2626
27- In ** ` ./client ` ** run:
27+ In ** ` ./client ` ** (in a separate terminal) run:
2828
2929``` sh
3030pnpm install && pnpm dev
3131```
3232
3333Open ` localhost:3000 ` in your browser.
3434
35- ### Development (with Smelter inside Docker)
35+ ## Development (with Smelter inside Docker)
3636
3737> Running Smelter inside a Docker container without GPU acceleration will be significantly slower. Check out ` compose.yml `
3838 to learn how to enable it on Nvidia and AMD cards.
3939
40- #### Start Smelter server
40+ #### Step 1: Start Smelter server
4141
4242In root directory run:
4343
4444``` sh
4545docker compose up
4646```
4747
48- #### Start Node.js server
48+ #### Step 2: Start Node.js server
4949
5050In ** ` ./server ` ** (in a separate terminal) run:
5151
@@ -56,7 +56,7 @@ SMELTER_INSTANCE_URL=http://localhost:8081 pnpm start
5656
5757This server will manage Smelter instance created in previous step.
5858
59- #### Start Next.js app
59+ #### Step 3: Start Next.js app
6060
6161In ** ` ./client ` ** (in a separate terminal) run:
6262
@@ -66,6 +66,6 @@ pnpm install && pnpm dev
6666
6767Open ` localhost:3000 ` in your browser.
6868
69- ### Production
69+ ## Production
7070
7171Run ` COMPOSE_PROFILES=prod docker compose up `
0 commit comments