diff --git a/apps/signalling-service/.env.example b/apps/signalling-service/.env.example new file mode 100644 index 0000000000..37300b8cdf --- /dev/null +++ b/apps/signalling-service/.env.example @@ -0,0 +1 @@ +PORT=4444 \ No newline at end of file diff --git a/apps/signalling-service/.gitignore b/apps/signalling-service/.gitignore index b512c09d47..1dcef2d9f2 100644 --- a/apps/signalling-service/.gitignore +++ b/apps/signalling-service/.gitignore @@ -1 +1,2 @@ -node_modules \ No newline at end of file +node_modules +.env \ No newline at end of file diff --git a/apps/signalling-service/README.md b/apps/signalling-service/README.md new file mode 100644 index 0000000000..f51e5e76b8 --- /dev/null +++ b/apps/signalling-service/README.md @@ -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) diff --git a/apps/signalling-service/package.json b/apps/signalling-service/package.json index bf481b9246..0160bc9f39 100644 --- a/apps/signalling-service/package.json +++ b/apps/signalling-service/package.json @@ -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": [],