Skip to content

Commit 7764ea7

Browse files
committed
docs: Added documentation
1 parent 84cbcda commit 7764ea7

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,25 @@
1-
Please dont use it production. And if you want to use it in production remove change certificate keys
2-
.
1+
# A webrtc demo with nextjs
2+
3+
### Requirements
4+
5+
1. Node >= v15.x
6+
2. npm >= v7
7+
8+
### Code structure
9+
10+
1. It is a monorepo managed by npm 7
11+
2. There are two packages backend and frontend
12+
3. Backend is just a small websocket server used for signaling
13+
4. Frontend is actual UI built with nextjs
14+
5. It uses google stun server for populating ice candidates
15+
16+
### How to run
17+
18+
1. Install all dependencies using `npm ci`
19+
1. npm run start --prefix packages/frontend
20+
1. npm run start --prefix packages/backend
21+
22+
### How to build
23+
24+
1. You dont need to build backend
25+
2. You can build frontend package with `npm run build --prefix packages/frontend` command

0 commit comments

Comments
 (0)