feat: github actions to build and pushes an image to the package repo

.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: Build and Push Docker Image
+
+on:
+    push:
+        branches:
+            - main
+
+jobs:
+    build-and-push:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Check out the repo
+              uses: actions/[email protected]
+
+            - name: Log in to GitHub Container Registry
+              uses: docker/login-action@v3
+              with:
+                  registry: ghcr.io
+                  username: ${{ github.actor }}
+                  password: ${{ secrets.GITHUB_TOKEN }}
+
+            - name: Build and push Docker image
+              uses: docker/[email protected]
+              with:
+                  context: .
+                  file: ./Dockerfile.dev
+                  push: true
+                  tags: ghcr.io/clue355/github_dev:dev

Dockerfile.dev

@@ -0,0 +1,45 @@
+# Specifies Node Version 18.18.2 & Alpine Linux Version 3.18 OS
+FROM node:18.18.2-alpine3.18
+
+# Application Container Root Directory
+WORKDIR /app
+
+# install pnpm globally inside container only
+RUN npm install -g pnpm
+
+# Copy dependency version files first to utilize dockers layer dependency caching
+COPY package.json pnpm-lock.yaml ./
+
+# install dependencies
+RUN pnpm install
+
+# Copy everything from the current DIR to the container DIR
+COPY . .
+
+# Starts the project
+CMD ["pnpm", "run", "dev"]
+
+# Specifies the port the container listens to
+EXPOSE 3000
+
+## build docker file and run in dev mode
+
+# docker build -f Dockerfile.dev -t your-image-name .
+# docker run --name container_name -p 3000:3000 -v $(pwd):/app image_name
+
+# Follow the real time logs again after stopping and starting the container
+# docker logs -f container_name
+
+# project link: http://localhost:3000/
+
+# or
+
+## build docker file and run in production mode
+
+# docker build -f Dockerfile.prod -t your-image-name .
+# docker run --name container_name -p 3000:3000 your-image-name
+
+# Follow the real time logs again after stopping and starting the container
+# docker logs -f container_name
+
+# project link: http://localhost:3000/

README.md

@@ -64,7 +64,7 @@ docker compose down app-dev
 
 `Note: After running docker compose down the image you pulled will still exist on your local computer`
 
-For production you just replace app-dev with app-prod
+`Note: For production you just replace app-dev with app-prod`
 
 ## Useful Docker commands