initial commit

Author: darrachequesne

.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 0 * * 0'
+
+permissions:
+  contents: read
+
+jobs:
+  test-server:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    strategy:
+      matrix:
+        node-version:
+          - 20
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Install dependencies
+        working-directory: ./server
+        run: npm ci
+
+      - name: Run tests
+        working-directory: ./server
+        run: npm test

.gitignore

@@ -0,0 +1 @@
+node_modules/

LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2023 The Socket.IO team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,50 @@
+# Socket.IO chat platform
+
+A basic chat platform based on [Socket.IO](https://socket.io/).
+
+Table of contents:
+
+<!-- TOC -->
+* [How to use](#how-to-use)
+* [Development](#development)
+  * [Server](#server)
+  * [Client](#client)
+* [Licence](#licence)
+<!-- TOC -->
+
+## How to use
+
+```shell
+$ docker compose up -d
+```
+
+Then go to http://localhost:8080
+
+## Development
+
+### Server
+
+```shell
+$ cd server
+
+# start the PostgreSQL database
+$ docker compose up -d
+
+# start the server
+$ npm run dev
+```
+
+### Client
+
+```shell
+$ cd vue-client
+
+# start the client
+$ npm run dev
+```
+
+Then go to http://localhost:5173
+
+## Licence
+
+[MIT](./LICENSE)

compose.yaml

@@ -0,0 +1,42 @@
+services:
+  nginx:
+    build:
+      context: .
+      dockerfile: nginx/Dockerfile
+    ports:
+      - "8080:80"
+    depends_on:
+      - backend01
+      - backend02
+      - backend03
+
+  backend01:
+    build:
+      context: ./server
+    depends_on:
+      db:
+        condition: service_healthy
+
+  backend02:
+    build:
+      context: ./server
+    depends_on:
+      db:
+        condition: service_healthy
+
+  backend03:
+    build:
+      context: ./server
+    depends_on:
+      db:
+        condition: service_healthy
+
+  db:
+    image: postgres:14
+    environment:
+      POSTGRES_PASSWORD: "changeit"
+    healthcheck:
+      test: [ "CMD-SHELL", "pg_isready -U postgres" ]
+      interval: 5s
+      timeout: 5s
+      retries: 5

nginx/Dockerfile

@@ -0,0 +1,19 @@
+### BUILD ###
+FROM node:20-alpine AS builder
+
+WORKDIR /tmp
+
+COPY ../vue-client/package*.json .
+
+RUN npm ci
+
+COPY ../vue-client/ .
+
+RUN npm run build
+
+### RUN ###
+FROM nginx:1.25
+
+COPY nginx/nginx.conf /etc/nginx/conf.d/default.conf
+
+COPY --from=builder /tmp/dist/ /usr/share/nginx/html/

nginx/nginx.conf

@@ -0,0 +1,38 @@
+upstream socket_io_nodes {
+    hash $remote_addr consistent;
+
+    server backend01:3000;
+    server backend02:3000;
+    server backend03:3000;
+}
+
+server {
+    listen 80;
+
+    root /usr/share/nginx/html;
+    index index.html;
+
+    location / {
+        try_files $uri $uri/ /index.html;
+
+        expires 0;
+        add_header Cache-Control "no-cache, no-store, must-revalidate";
+    }
+
+    location ~* \.(ico|css|js|gif|jpeg|jpg|png|woff|ttf|otf|svg|woff2|eot)$ {
+        expires 1y;
+        add_header Pragma public;
+        add_header Cache-Control public;
+    }
+
+    location /api/ {
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header Host $host;
+
+        proxy_pass http://socket_io_nodes/;
+
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection upgrade;
+    }
+}

server/.dockerignore

@@ -0,0 +1,3 @@
+node_modules/
+test/
+index.js

server/Dockerfile

@@ -0,0 +1,17 @@
+FROM node:20-alpine
+
+RUN mkdir -p /home/node/app/node_modules && chown -R node:node /home/node/app
+
+WORKDIR /home/node/app
+
+COPY package*.json ./
+
+USER node
+
+RUN npm ci --omit=dev
+
+COPY --chown=node:node . .
+
+EXPOSE 3000
+
+CMD [ "node", "entrypoint.js" ]

server/compose.yaml

@@ -0,0 +1,7 @@
+services:
+  postgres:
+    image: postgres:14
+    ports:
+      - "5432:5432"
+    environment:
+      POSTGRES_PASSWORD: "changeit"