Merge pull request #105 from GTBitsOfGood/hc/103-dockerize

hc/103-dockerize

.babelrc

@@ -0,0 +1 @@
+{"presets": ["next/babel"]}

.husky/pre-commit

@@ -1,4 +1,8 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-npm run lint && npm run format
+if [ "$USE_DOCKER" = "true" ]; then
+  NODE_COMMAND=lint docker-compose up --build --exit-code-from app app && NODE_COMMAND=format docker-compose up --build --exit-code-from app app
+else
+  npm run lint && npm run format
+fi

Dockerfile

@@ -0,0 +1,14 @@
+FROM node:16
+WORKDIR /usr/src/app
+COPY package.json package-lock.json ./
+RUN npm ci
+EXPOSE 3000
+RUN /bin/bash
+ENV NODE_COMMAND=dev
+
+# If you want to use a different command, pass the NODE_COMMAND env variable to 
+# docker-compose up --build
+
+# Ex. NODE_COMMAND=build docker-compose up --build
+
+ENTRYPOINT ["sh", "-c", "npm run $NODE_COMMAND"]

README.md

@@ -14,6 +14,37 @@
 
 1. Clone this project to your computer
 2. Navigate to this project in your terminal
+### Use with Docker
+3. Install docker and docker-compose
+
+MacOS: [Docker Desktop for MacOS](https://docs.docker.com/desktop/install/mac-install/)
+
+Windows: [Docker Desktop for Windows](https://docs.docker.com/desktop/install/windows-install/)
+
+Linux: [Docker Desktop for Linux](https://docs.docker.com/desktop/install/linux-install/)
+
+4. Obtain your secrets -- **Linux or MacOS** (Skip if Windows); you will need to obtain a password from your Engineering Manager:
+
+First, install **BitWarden CLI** and **fx** with `npm install -g @bitwarden/cli fx`
+
+Or, if you're using Homebrew, run `brew install bitwarden-cli fx`
+
+Now fetch the secrets from BitWarden with `yarn secrets:linux`
+
+4. Obtain your secrets -- **Windows Machines** (Skip if MacOS or Linux); you will need to obtain a password from your Engineering Manager:
+
+First, install **BitWarden CLI** and **fx** with npm with `npm install -g @bitwarden/cli fx`
+
+Now fetch the secrets from BitWarden with `yarn secrets:login` and `yarn secrets:sync`
+
+5. Run `docker-compose up --build` to run the dev environment
+
+To run build or any other script specified in the package.json, provide the NODE_COMMAND environment variable before docker-compose like `NODE_COMMAND=build docker-compose up --build`
+
+### Use without Docker
+
+__Note__: You might want to remove the .babelrc file from your local directory to enable SWC, a faster compiler for Next.js than Babel. __This will break Docker__.
+
 3. Run `npm ci` to retrieve dependencies
 4. Run `npm run secrets` to sync secrets to `.env.local`
    - You will be asked for a password, ask your EM to send it to you

docker-compose.yml

@@ -0,0 +1,16 @@
+version: "3"
+
+services:
+  app:
+    build:
+      context: .
+    environment:
+      - NODE_COMMAND=${NODE_COMMAND:-dev}
+      - COMMIT_MSG=${COMMIT_MSG:-""}
+    ports:
+      - "3000:3000"
+    env_file:
+      - .env.local
+    volumes:
+      - .:/usr/src/app
+      - /usr/src/app/node_modules

netlify.toml

@@ -0,0 +1,2 @@
+[build]
+  command = "npm run build"