Add dev container

.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+{
+  "customizations": {
+    "vscode": {
+      "sonarlint.pathToNodeExecutable": "node",
+      "terminal.integrated.shell.linux": "/bin/bash"
+    }
+  },
+  "dockerComposeFile": "../docker-compose.dev.yaml",
+  "features": {
+    "ghcr.io/devcontainers/features/common-utils:2": {},
+    "ghcr.io/devcontainers/features/git:1": {},
+    "ghcr.io/devcontainers/features/java:1": {}
+  },
+  "forwardPorts": [
+    8080
+  ],
+  "name": "finki-discord-bot",
+  "postCreateCommand": "npm i",
+  "service": "bot",
+  "shutdownAction": "stopCompose",
+  "workspaceFolder": "/app"
+}

.dockerignore

@@ -1,16 +1,30 @@
 # Node modules
 node_modules
 
+# Git
+.git
+.gitignore
+
+# Docker
+.dockerignore
+Dockerfile*
+docker-compose*
+
 # Output
 dist
 
 # Logs
 bot.log
 
-# User defined folders
+# Configuration
 config
 files
 sessions
 
-# Environment variables
-.env
+# Environment
+.env*
+
+# GitHub
+.github
+*.md
+LICENSE

.gitignore

@@ -195,9 +195,9 @@ files
 config
 
 # Database
-db
+db/
 migration/
-pgadmin
+pgadmin/
 
 # Compiled output
 dist

.vscode/extensions.json

@@ -4,11 +4,11 @@
     "Prisma.prisma",
     "dbaeumer.vscode-eslint",
     "esbenp.prettier-vscode",
-    "github.vscode-codeql",
     "me-dutour-mathieu.vscode-github-actions",
     "meganrogge.template-string-converter",
     "mikestead.dotenv",
     "ms-azuretools.vscode-docker",
+    "ms-azuretools.vscode-docker",
     "ms-vscode-remote.remote-containers",
     "sonarsource.sonarlint-vscode",
     "yoavbls.pretty-ts-errors"

Dockerfile

@@ -1,7 +1,7 @@
 ARG PLATFORM="linux/amd64"
 
 # Build stage
-FROM --platform=${PLATFORM} node:20-alpine AS build
+FROM node:20 AS development
 WORKDIR /app
 
 COPY package*.json ./
@@ -15,18 +15,23 @@ RUN npm run build
 
 COPY start.sh ./
 
-RUN npm prune --production
+RUN apt-get update && apt-get install postgresql-client gnupg2 -y && apt-get clean
+
+COPY nodemon.json ./
+
+CMD [ "npm", "run", "dev" ]
 
 # Production stage
-FROM node:20-alpine AS production
+FROM --platform=${PLATFORM} node:20-alpine AS production
 WORKDIR /app
 
-RUN apk update && apk add postgresql-client && apk cache clean
-
 COPY --from=build /app/dist ./dist
-COPY --from=build /app/node_modules ./node_modules
 COPY --from=build /app/prisma ./prisma
 COPY --from=build /app/package.json ./
 COPY --from=build /app/start.sh ./
 
-CMD [ "sh", "/app/start.sh" ]
+RUN npm i --production
+
+RUN apk update && apk add postgresql-client && apk cache clean
+
+CMD [ "npm", "run", "start" ]

README.md

@@ -8,6 +8,8 @@ It's recommended, but not required to run this inside a Docker container.
 
 For development purposes, be sure to run `npm run prepare` to install the Git pre-commit hooks.
 
+Also, this project contains a dev container configuration for hot reloading. If you encounter issues in the dev container with Prisma, then run `npm run generate` to regenerate the Prisma client.
+
 ### Installation (Docker)
 
 1. Clone the repository: `git clone [email protected]:Delemangi/finki-discord-bot.git`

docker-compose.dev.yaml

@@ -0,0 +1,43 @@
+version: "3.8"
+
+services:
+  database:
+    container_name: finki-database-dev
+    image: postgres:16
+    restart: unless-stopped
+    ports:
+      - "${POSTGRES_PORT}:${POSTGRES_PORT}"
+    env_file:
+      - .env
+    volumes:
+      - ./db:/var/lib/postgresql/data
+
+  bot:
+    container_name: finki-bot-dev
+    build:
+      context: .
+      dockerfile: ./Dockerfile
+      target: development
+    image: finki-discord-bot-dev:latest
+    restart: unless-stopped
+    env_file:
+      - .env
+    depends_on:
+      - database
+    volumes:
+      - .:/app
+    command: ["npm", "run", "dev"]
+
+  pgadmin:
+    container_name: finki-pgadmin-dev
+    image: dpage/pgadmin4:8
+    restart: unless-stopped
+    ports:
+      - 8080:80
+    environment:
+      - [email protected]
+      - PGADMIN_DEFAULT_PASSWORD=test
+    depends_on:
+      - database
+    volumes:
+      - ./pgadmin:/var/lib/pgadmin

docker-compose.yaml

@@ -1,8 +1,8 @@
 version: "3.8"
 
 services:
-  db:
-    container_name: finki-db
+  database:
+    container_name: finki-database
     image: postgres:16
     restart: unless-stopped
     env_file:
@@ -12,13 +12,12 @@ services:
 
   bot:
     container_name: finki-bot
-    image: finki-discord-bot:latest
-    build: .
+    image: delemangi/finki-discord-bot:latest
     restart: unless-stopped
     env_file:
       - .env
     depends_on:
-      - db
+      - database
     volumes:
       - ./config:/app/config
       - ./sessions:/app/sessions

nodemon.json

@@ -0,0 +1,11 @@
+{
+  "exec": "node --loader ts-node/esm ./src/main.ts",
+  "ext": "*",
+  "legacyWatch": true,
+  "watch": [
+    "src"
+  ],
+  "watchOptions": {
+    "interval": 1000
+  }
+}