feat: using bun

Author: wjohnsto

Dockerfile

@@ -1,32 +1,41 @@
-FROM node:20-alpine AS base
-WORKDIR /app
-
-FROM base AS deps
-COPY package-lock.json ./package-lock.json
-COPY package.json ./package.json
-RUN npm install
-
-FROM base AS prod-deps
-COPY package-lock.json ./package-lock.json
-COPY package.json ./package.json
-RUN npm install --omit=dev
-
+# use the official Bun image
+# see all versions at https://hub.docker.com/r/oven/bun/tags
+FROM oven/bun:1.2-alpine AS base
+WORKDIR /usr/src/app
+
+# install dependencies into temp directory
+# this will cache them and speed up future builds
+FROM base AS install
+RUN mkdir -p /temp/dev
+COPY package.json bun.lock /temp/dev/
+RUN cd /temp/dev && bun install --frozen-lockfile
+
+# install with --production (exclude devDependencies)
+RUN mkdir -p /temp/prod
+COPY package.json bun.lock /temp/prod/
+RUN cd /temp/prod && bun install --frozen-lockfile --production
+
+# copy node_modules from temp directory
+# then copy all (non-ignored) project files into the image
 FROM base AS dev
-COPY --from=deps /app/node_modules ./node_modules
+COPY --from=install /temp/dev/node_modules node_modules
 COPY . .
 
-FROM base AS runner
-ENV NODE_ENV production
-COPY --from=prod-deps /app/node_modules ./node_modules
+# copy node_modules from temp directory
+# then copy all (non-ignored) project files into the image
+FROM base AS prerelease
+COPY --from=install /temp/dev/node_modules node_modules
 COPY . .
-
-ENV PORT 3000
-
-EXPOSE ${PORT}
-
-# set hostname to localhost
-ENV HOSTNAME "0.0.0.0"
-
-# server.js is created by next build from the standalone output
-# https://nextjs.org/docs/pages/api-reference/next-config-js/output
-CMD ["node", "."]
+ENV NODE_ENV=production
+RUN bun build --target=bun . --outdir build/
+
+# copy production dependencies and source code into final image
+FROM base AS release
+COPY --from=install /temp/prod/node_modules node_modules
+COPY --from=prerelease /usr/src/app/build/server/index.js .
+COPY --from=prerelease /usr/src/app/package.json .
+
+# run the app
+USER bun
+EXPOSE 3000/tcp
+ENTRYPOINT [ "bun", "index.js" ]

README.md

@@ -5,9 +5,9 @@ This is a [Redis](https://redis.io/) starter template for JS and [Node](https://
 
 ## Requirements
 
-- [node>=22](https://nodejs.org/)
+- [bun](https://bun.sh/)
 - [docker](https://www.docker.com/)
-   - Optional
+  - Optional
 
 ## Getting started
 
@@ -46,7 +46,7 @@ You should have a server running on `http://localhost:<port>` where the port is
 There are some tests in the `__tests__` folder that can be run with the following command:
 
 ```bash
-npm test
+bun test
 ```
 
 These tests setup and teardown on their own. You can modify them if you want to leave data in Redis.
@@ -56,17 +56,17 @@ These tests setup and teardown on their own. You can modify them if you want to
 To run the development server outside of docker:
 
 ```bash
-npm install
+bun install
 # then
-npm run dev
+bun dev
 ```
 
 ## Other Scripts
 
 Formatting code:
 
 ```bash
-npm run format
+bun format
 ```
 
 ## Connecting to Redis Cloud

__tests__/todos.test.js

@@ -5,7 +5,7 @@ import {
   describe,
   expect,
   test,
-} from "vitest";
+} from "bun:test";
 import request from "supertest";
 import app from "../server/app.js";
 import * as todos from "../server/components/todos/store.js";

bun.lock

@@ -0,0 +1 @@
+import "dotenv/config";

bun.pretest.js

@@ -0,0 +1,2 @@
+[test]
+preload = ["./bun.pretest.js"]

bunfig.toml

@@ -18,15 +18,15 @@ services:
       context: ./
       dockerfile: ./Dockerfile
       target: dev
-    command: npm run dev
+    command: bun dev
     ports:
       - 3000:3000
     env_file:
       - ./.env
       - ./.env.docker
     volumes:
-      - ./server:/app/server
-      - /app/node_modules
+      - ./server:/usr/src/app/server
+      - /usr/src/app/node_modules
     restart: always
     depends_on:
       - redis