Merge pull request #26 from domesticchores/docker

updated and containerized

Author: costowell

.dockerignore

@@ -0,0 +1,32 @@
+# 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/go/build-context-dockerignore/
+
+**/.classpath
+**/.dockerignore
+**/.env
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/.next
+**/.cache
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/charts
+**/docker-compose*
+**/compose.y*ml
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+**/build
+**/dist
+README.md

Dockerfile

@@ -0,0 +1,42 @@
+# 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/go/dockerfile-reference/
+
+# Want to help us make this template better? Share your feedback here: https://forms.gle/ybq9Krt8jtBL3iCk7
+
+ARG NODE_VERSION=20.19.4
+
+FROM node:${NODE_VERSION}-alpine
+
+# 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 . .
+
+# Load default port if not specified in build command
+ARG PORT=8080
+ENV PORT=${PORT}
+
+# Expose the port that the application listens on.
+EXPOSE ${PORT}
+
+# Run the application.
+CMD node server.js

README.md

@@ -18,6 +18,33 @@ Implement as:
 ## Contributing
 ### Pull Requests
 To contribute to themeswitcher, please fork this repository and submit a pull request. If it is a significant change (more than a couple lines) please create a new branch. Excluding ReadMe changes, pull requests to site will not be accepted.
+
+### Environment Variables
+Create a `.env` file in the root directory using the following template. Contact an RTP to get the necessary secrets.
+```
+CLIENT_ID=themeswitcher
+CLIENT_SECRET=
+DEFAULT_CSS=csh-bootstrap-bootstrap
+EXPRESS_SESSION_SECRET=
+PORT=8080
+HOST=http://localhost:8080
+DB_URI=mongodb://themes:2cvtwcdye837nscp38@mongodb-theme:27017/themes?authSource=admin
+```
+For local development, the `DB_URI` is already populated with the URI to use the mongo image created in the docker compose. If you know what you're doing you can host and use your own DB, but why would you do that when there's one right here?
+### Viewing Local Database
+If you're developing locally, viewing the database contents for debugging can be achieved using the following commands:
+1. Authenticate into the database
+```bash
+ docker exec -it mongodb-theme mongosh -u themes -p <yourpasswordhere> --authenticationDatabase admin
+```
+2. Select the `themes` table
+```bash
+use themes
+```
+3. view the `members` collection and return JSON data
+```bash
+ db.members.find().pretty()
+```
 ### Issues
 As themeswitcher is hosted on GitHub, it uses GitHub's issue tracker to document issues. Please open any issues there.
 ### Adding Themes

docker-compose.yaml

@@ -0,0 +1,34 @@
+services:
+  themeswitcher:
+    build: .
+    container_name: themeswitcher
+    depends_on:
+      - mongodb
+    environment:
+      HOST: "${HOST}"
+      DB_URI: "${DB_URI}"
+      CLIENT_ID: "${CLIENT_ID}"
+      CLIENT_SECRET: "${CLIENT_SECRET}"
+      DEFAULT_CSS: "${DEFAULT_CSS}"
+      EXPRESS_SESSION_SECRET: "${EXPRESS_SESSION_SECRET}"
+      PORT: "${PORT}"
+    ports:
+      - "${PORT}:${PORT}"
+
+  mongodb:
+    image: mongo:8.0-rc-noble
+    container_name: mongodb-theme
+    command: "mongod --bind_ip 0.0.0.0"
+    environment:
+      - "MONGO_INITDB_DATABASE=themes"
+      - "MONGO_INITDB_ROOT_USERNAME=themes"
+      - "MONGO_INITDB_ROOT_PASSWORD=2cvtwcdye837nscp38"
+    ports:
+      - "27017:27017"
+    volumes:
+      - type: volume
+        source: mongodb
+        target: /data/db/
+
+volumes:
+  mongodb: