Merge pull request #3 from eniraa/docker

add docker things

Author: marigarey

.dockerignore

@@ -0,0 +1,35 @@
+# Include any files or directories that you don't want to be copied to your
+# container here (e.g., local build artifacts, temporary files, etc.).
+#
+# For more help, visit the .dockerignore file reference guide at
+# https://docs.docker.com/engine/reference/builder/#dockerignore-file
+
+**/.classpath
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/.next
+**/.cache
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/charts
+**/docker-compose*
+**/compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+**/build
+**/dist
+LICENSE.txt
+README.md
+SECURITY.md

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+    - 
+        package-ecosystem: "github-actions"
+        directory: "/"
+        schedule:
+            interval: "daily"
+    - 
+        package-ecosystem: "npm"
+        directory: "/"
+        schedule:
+            interval: "daily"

.github/workflows/build.yml

@@ -0,0 +1,41 @@
+name: Build
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+        if: github.ref == 'refs/heads/main'
+        permissions:
+            packages: write
+        steps:
+            -
+                name: Checkout
+                uses: actions/checkout@v4
+            -
+                name: Set up QEMU
+                uses: docker/setup-qemu-action@v3
+            -
+                name: Set up Docker Buildx
+                uses: docker/setup-buildx-action@v3
+            -
+                name: Login 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/build-push-action@v6
+                with:
+                    context: .
+                    platforms: linux/amd64,linux/arm/v6,linux/arm/v7,linux/arm64,linux/ppc64le,linux/s390x
+                    push: true
+                    tags: ghcr.io/${{ github.repository }}:latest
+                    cache-from: type=gha
+                    cache-to: type=gha,mode=max

Dockerfile

@@ -0,0 +1,29 @@
+# syntax=docker/dockerfile:1
+
+# Comments are provided throughout this file to help you get started.
+# If you need more help, visit the Dockerfile reference guide at
+# https://docs.docker.com/engine/reference/builder/
+FROM node:alpine3.19
+# Use production node environment by default.
+ENV NODE_ENV production
+
+
+WORKDIR /usr/src/app
+
+# Download dependencies as a separate step to take advantage of Docker's caching.
+# Leverage a cache mount to /root/.npm to speed up subsequent builds.
+# Leverage a bind mounts to package.json and package-lock.json to avoid having to copy them into
+# into this layer.
+RUN --mount=type=bind,source=package.json,target=package.json \
+    --mount=type=bind,source=package-lock.json,target=package-lock.json \
+    --mount=type=cache,target=/root/.npm \
+    npm ci --omit=dev
+
+# Run the application as a non-root user.
+USER node
+
+# Copy the rest of the source files into the image.
+COPY . .
+
+# Run the application.
+CMD node main.js

README.md

@@ -29,11 +29,29 @@ git clone https://github.com/marigarey/canvas-notion-integration.git
 
 # Open this project
 cd canvas-notion-integration
+```
 
+#### Without Docker
+```zsh
 # Install dependencies
 npm install
 ```
 
+#### With Docker
+```zsh
+# Build image
+docker -t canvas-notion-integration build .
+```
+
+> [!NOTE]
+> This step is not required on most architectures. GHCR should have built the latest version on the following architectures:
+> - `linux/amd64`
+> - `linux/arm/v6`
+> - `linux/arm/v7`
+> - `linux/arm64`
+> - `linux/ppc64le`
+> - `linux/s390x`
+
 ### 2. Canvas Token Access
 
 Go to your Canvas Profile Settings and scroll down to `Approved Integrations`.
@@ -82,14 +100,23 @@ NOTION_DATABASE='default'
 
 ### 6. Run Code
 
-```zhs
-node main.js
-```
-
 > [!IMPORTANT]
 > To update your database you will have to run the script every time there is a change in Canvas
 > It is recomended to rerun the code every semester or class/assignment changes
 
+#### Without Docker
+```zsh
+node main.js
+```
+
+#### With Docker
+```zsh
+docker run --env-file ./.env canvas-notion-integration
+```
+
+> [!NOTE]
+> If you did not choose to build the image yourself, you can replace `canvas-notion-integration` with `ghcr.io/marigarey/canvas-notion-integration:latest`
+
 ## Other Information
 
 In the future I do plan to add more to this, possibly blocks outside of the database.