Merge pull request #44 from diegonicacio/docker-local-build

Local docker configuration build + documentation 📝

.github/workflows/ci.yaml

@@ -52,6 +52,7 @@ jobs:
         with:
           context: .
           platforms: linux/amd64,linux/arm64
-          push: ${{ github.event_name != 'pull_request' }}
+          # push: ${{ github.event_name != 'pull_request' }}
+          push: false
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}

Dockerfile

@@ -3,7 +3,6 @@ FROM node:16-alpine AS deps
 RUN apk add --no-cache libc6-compat
 WORKDIR /app
 
-COPY . ./
 COPY package.json yarn.lock* package-lock.json* pnpm-lock.yaml* ./
 RUN \
 	if [ -f yarn.lock ]; then yarn --frozen-lockfile; \
@@ -38,5 +37,6 @@ COPY --chown=node --from=builder /app/node_modules ./node_modules
 
 USER node
 EXPOSE 3000
+ENV NEXT_TELEMETRY_DISABLED 1
 
-CMD ["npm run", "start"]
+CMD ["npm", "run", "start"]

README.md

@@ -33,6 +33,12 @@ New Features
 
 ## Self Hosting
 
+**PREPARE**
+
+MagLit uses Firebase Firestore as a database. You must first create a new Firebase project, then a file with the name `.env.local` in root directory of the project and fill the details as mentioned in `.env.local.example`.
+
+This step is a **hard requeriment** and any change to this file, **requires a rebuild to the project from scratch** (either through npm install/npm run dev or by using the docker steps)
+
 Clone the project and install dependencies using:
 
 ```bash
@@ -50,23 +56,16 @@ npm run dev
 **DOCKER:**
 
 ```
-# TO BUILD IMAGE
-npm run build-docker-image
-
-# TO START THE DOCKER IMAGE SERVER
-npm run start-docker-image
+#  BUILD AND RUN IMAGE USING NPM
+npm run docker
 ```
 
-You can also use a pre-built image (supports amd64 and arm64), which contains the code that resides on `main`:
+OR
 
 ```
-docker pull ghcr.io/nayamamarshe/maglit:main
-```
-
-The `docker-compose` file is setup to use the remote image. Just remember to fill the firebase environment variables. You can start using docker compose with:
-
-```
-docker compose up -d
+# MANUALLY BUILD AND RUN IMAGE USING COMPOSE
+sudo docker-compose build
+sudo docker-compose up -d
 ```
 
 Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
@@ -77,8 +76,6 @@ You can start editing the page by modifying `pages/index.js`. The page auto-upda
 
 The `pages/api` directory is mapped to `/api/*`. Read more about [API routes](https://nextjs.org/docs/api-routes/introduction).
 
-MagLit uses Firebase Firestore as a database. You must first create a new Firebase project, then a file with the name `.env.local` in root directory of the project and fill the details as mentioned in `.env.local.example`.
-
 ## If you like the project
 
 ETH (ERC-20) Wallet: **0x14858f5334ea1014e68212c2d4b32792d137f256**

docker-compose.yaml

@@ -1,17 +1,12 @@
 version: "3.9"
 services:
   maglit:
-    image: ghcr.io/nayamamarshe/maglit:main
+    image: local/maglit:latest 
+    build:
+      context: .
+      target: runner
+      dockerfile: Dockerfile
     ports:
       - "3000:3000"
-    environment:
-      NEXT_PUBLIC_BASE_URL: "http://localhost.com:3000/"
-      #Firebase configs below
-      API_KEY: ""
-      AUTH_DOMAIN: ""
-      PROJECT_ID: ""
-      STORAGE_BUCKET: ""
-      MESSAGING_SENDER_ID: ""
-      APP_ID: ""
-      MEASUREMENT_ID: ""
-
+    env_file:
+      - .env.local

package.json

@@ -6,8 +6,7 @@
     "build": "next build",
     "start": "next start",
     "lint": "next lint",
-    "build-docker-image": "sudo docker build -t maglit .",
-    "start-docker-image": "sudo docker run -p 3000:3000 maglit"
+    "docker": "sudo docker-compose build && sudo docker-compose up -d"
   },
   "dependencies": {
     "crypto-js": "^4.1.1",