Skip to content

Commit

Permalink
Add documentation for signalling server
Browse files Browse the repository at this point in the history
  • Loading branch information
bensohh committed Oct 25, 2024
1 parent e5acf02 commit a03dbb5
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 2 deletions.
1 change: 1 addition & 0 deletions apps/signalling-service/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
PORT=4444
3 changes: 2 additions & 1 deletion apps/signalling-service/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
node_modules
node_modules
.env
28 changes: 28 additions & 0 deletions apps/signalling-service/README.md
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)
3 changes: 2 additions & 1 deletion apps/signalling-service/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"description": "",
"main": "server.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
"test": "echo \"Error: no test specified\" && exit 1",
"dev": "node server.js"
},
"type": "module",
"keywords": [],
Expand Down

0 comments on commit a03dbb5

Please sign in to comment.