nuxt-bun-compile 0.1.25 → 0.1.26

package/README.md

@@ -172,6 +172,86 @@ The **`-b`** (or `--bun`) flag forces Bun to be the runtime that executes the sc
 
 ---
 
+## 📚 Usage Examples
+
+### Custom Build Script
+
+Create a dedicated npm script in your `package.json`:
+
+```json
+{
+  "scripts": {
+    "build": "nuxt build",
+    "compile": "NODE_OPTIONS=\"--max-old-space-size=8192\" bun run -b build"
+  }
+}
+```
+
+Then run: `bun run compile`
+
+### Docker Deployment
+
+Before building, create a `.dockerignore` file to exclude unnecessary files from the build context:
+
+```
+.claude
+.devcontainer
+.gemini
+.git
+.github
+.husky
+.nuxt
+.output
+.serena
+.vscode
+.yarn
+dist
+node_modules
+nuxtbin
+test
+tests
+```
+
+Deploy the compiled binary in a Docker container using multi-stage build:
+
+```dockerfile
+# Stage 1: Base image with Bun runtime
+FROM oven/bun:alpine AS bun-base
+WORKDIR /app
+
+# Stage 2: Install dependencies
+FROM bun-base AS bun-install
+COPY package.json bun.lockb ./
+RUN bun install --frozen-lockfile
+
+# Stage 3: Build the binary
+FROM bun-base AS bun-build
+COPY --from=bun-install /app/node_modules /app/node_modules
+COPY . .
+RUN NODE_OPTIONS="--max-old-space-size=8192" bun run -b build
+
+# Stage 4: Release (lightweight production image)
+FROM alpine:latest AS release
+EXPOSE 3000/tcp
+WORKDIR /app
+# Required libraries for Bun binaries on Alpine
+# See: https://github.com/oven-sh/bun/issues/23910
+#      https://github.com/oven-sh/bun/issues/918
+RUN apk add --no-cache libstdc++ libgcc
+COPY --from=bun-build /app/nuxtbin /app/nuxtbin
+CMD ["./nuxtbin"]
+```
+
+Build and run:
+```bash
+docker build -t my-nuxt-app .
+docker run -p 3000:3000 my-nuxt-app
+```
+
+> **Reference:** See the complete multi-stage example in [nuxt-duckdb-wasm/Dockerfile](https://github.com/jprando/nuxt-duckdb-wasm/blob/main/Dockerfile) for a production-ready setup.
+
+---
+
 ## 🧑‍💻 Development
 
 ### Testing Locally in a Nuxt App

package/README.ptBR.md

@@ -172,6 +172,86 @@ O parâmetro **`-b`** (ou `--bun`) força o Bun a ser o runtime que executa o sc
 
 ---
 
+## 📚 Exemplos de Uso
+
+### Script Customizado de Build
+
+Crie um script npm/bun dedicado no seu `package.json`:
+
+```json
+{
+  "scripts": {
+    "build": "nuxt build",
+    "compile": "NODE_OPTIONS=\"--max-old-space-size=8192\" bun run -b build"
+  }
+}
+```
+
+Execute com: `bun run compile`
+
+### Deploy com Docker
+
+Antes de compilar, crie um arquivo `.dockerignore` para excluir arquivos desnecessários do contexto de build:
+
+```
+.claude
+.devcontainer
+.gemini
+.git
+.github
+.husky
+.nuxt
+.output
+.serena
+.vscode
+.yarn
+dist
+node_modules
+nuxtbin
+test
+tests
+```
+
+Faça deploy do binário compilado em um container Docker usando multi-stage build:
+
+```dockerfile
+# Estágio 1: Imagem base com runtime Bun
+FROM oven/bun:alpine AS bun-base
+WORKDIR /app
+
+# Estágio 2: Instalar dependências
+FROM bun-base AS bun-install
+COPY package.json bun.lockb ./
+RUN bun install --frozen-lockfile
+
+# Estágio 3: Compilar o binário
+FROM bun-base AS bun-build
+COPY --from=bun-install /app/node_modules /app/node_modules
+COPY . .
+RUN NODE_OPTIONS="--max-old-space-size=8192" bun run -b build
+
+# Estágio 4: Release (imagem de produção otimizada)
+FROM alpine:latest AS release
+EXPOSE 3000/tcp
+WORKDIR /app
+# Bibliotecas necessárias para binários Bun no Alpine
+# Ver: https://github.com/oven-sh/bun/issues/23910
+#      https://github.com/oven-sh/bun/issues/918
+RUN apk add --no-cache libstdc++ libgcc
+COPY --from=bun-build /app/nuxtbin /app/nuxtbin
+CMD ["./nuxtbin"]
+```
+
+Build e execute:
+```bash
+docker build -t minha-app-nuxt .
+docker run -p 3000:3000 minha-app-nuxt
+```
+
+> **Referência:** Veja um exemplo completo com multi-stage em [nuxt-duckdb-wasm/Dockerfile](https://github.com/jprando/nuxt-duckdb-wasm/blob/main/Dockerfile) para um setup pronto para produção.
+
+---
+
 ## 🧑‍💻 Desenvolvimento
 
 ### Testando Localmente em uma Aplicação Nuxt

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-bun-compile",
   "configKey": "bunCompile",
-  "version": "0.1.25",
+  "version": "0.1.26",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-bun-compile",
-  "version": "0.1.25",
+  "version": "0.1.26",
   "description": "Nuxt module that automatically configures Nitro for `bun build --compile`, generating a standalone executable binary from your Nuxt app.",
   "repository": "jprando/nuxt-bun-compile",
   "license": "MIT",