-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation for signalling server
- Loading branch information
Showing
4 changed files
with
33 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
PORT=4444 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
node_modules | ||
node_modules | ||
.env |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
This is a signalling server that is used to establish WebRTC connections between users. It is built using Node.js and Socket.IO. | ||
|
||
## Getting Started | ||
|
||
First, install the dependencies: | ||
|
||
```bash | ||
npm install -g pnpm | ||
|
||
pnpm install --frozen-lockfile | ||
|
||
# if pnpm install --frozen-lockfile fails, try running | ||
pnpm install | ||
``` | ||
|
||
Then, follow the `.env.example` file and create a `.env` file in the current directory. Replace the necessary values within. | ||
|
||
```bash | ||
PORT=4444 | ||
``` | ||
|
||
First, run the development server: | ||
|
||
```bash | ||
pnpm dev | ||
``` | ||
|
||
## Build Dockerfile (TODO) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters