Merge pull request #12 from remotemerge/docker-dev-setup

Docker Dev Setup

.github/workflows/install.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        os: [ ubuntu-20.04, ubuntu-22.04, ubuntu-24.04, windows-latest, macos-latest ]
         node-version: [18, 20, 22]
       fail-fast: false
 
@@ -28,10 +28,10 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - name: Generate package.json file
-        run: npm init -y
+        run: cd html && npm init -y
 
-      - name: Install ndc package
-        run: npm install @remotemerge/nepali-date-converter
+      - name: Install Nepali Date Converter
+        run: cd html && npm install @remotemerge/nepali-date-converter
 
       - name: List installed packages
-        run: npm list --depth=0
+        run: cd html && npm list --depth=0

.github/workflows/publish.yml

@@ -23,12 +23,15 @@ jobs:
           registry-url: 'https://registry.npmjs.org'
 
       - name: Install dependencies
-        run: npm install
+        run: cd html && npm install
 
       - name: Build project
-        run: npm run build
+        run: cd html && npm run build
+
+      - name: Copy Documentation and License
+        run: cp README.md LICENSE html/dist
 
       - name: Publish the package to npm
-        run: npm publish ./dist --access public
+        run: cd html && npm publish ./dist --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}

.github/workflows/test.yml

@@ -1,16 +1,16 @@
 name: Test
 
 # Trigger the workflow on pull requests
-on: [pull_request]
+on: [ pull_request ]
 
 jobs:
   test:
     # Run on multiple operating systems
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [18, 20, 22]
+        os: [ ubuntu-24.04, windows-latest, macos-latest ]
+        node-version: [ 18, 20, 22 ]
       fail-fast: false
 
     steps:
@@ -23,13 +23,13 @@ jobs:
           node-version: ${{ matrix.node-version }}
 
       - name: Install dependencies
-        run: npm install
+        run: cd html && npm install
 
       - name: Build project
-        run: npm run build
+        run: cd html && npm run build
 
       - name: Create data file
-        run: npx shx cp __tests__/data.dist.json __tests__/data.json
+        run: cd html && npx shx cp __tests__/data.dist.json __tests__/data.json
 
       - name: Run Tests
-        run: npm run test
+        run: cd html && npm run test

.gitignore

@@ -1,12 +1,12 @@
 ### Vendor directories
-/.yarn/
-/node_modules/
-/vendor/
+/html/.yarn/
+/html/node_modules/
+/html/vendor/
 
 ### Build directories
-/build/
-/bundle/
-/dist/
+/html/build/
+/html/bundle/
+/html/dist/
 
 ### JetBrains
 /.idea/*
@@ -56,4 +56,4 @@ pnpm-lock.yaml
 yarn.lock
 
 ## Data Files
-/__tests__/data.json
+/html/__tests__/data.json

README.md

@@ -2,7 +2,7 @@
 
 [![Package](https://img.shields.io/npm/v/@remotemerge/nepali-date-converter?logo=npm)](https://www.npmjs.com/package/@remotemerge/nepali-date-converter)
 ![Build](https://img.shields.io/github/actions/workflow/status/remotemerge/nepali-date-converter/publish.yml?logo=github)
-![Tests](https://img.shields.io/github/actions/workflow/status/remotemerge/nepali-date-converter/test.yml?style=flat&logo=counterstrike&label=test)
+![Tests](https://img.shields.io/github/actions/workflow/status/remotemerge/nepali-date-converter/test.yml?&logo=jest&label=test)
 ![Downloads](https://img.shields.io/npm/dt/@remotemerge/nepali-date-converter?logo=spreadshirt)
 [![Size](https://img.shields.io/bundlephobia/minzip/@remotemerge/nepali-date-converter?logo=ipfs&label=size)](https://bundlephobia.com/result?p=@remotemerge/nepali-date-converter)
 ![License](https://img.shields.io/github/license/remotemerge/nepali-date-converter?logo=opensourceinitiative)

app-cli.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+# Login to the app container
+docker compose --file ducker-compose.yml exec --user node npm-dev-server bash

ducker-compose.yml

@@ -0,0 +1,30 @@
+# Docker Compose configuration for NPM package deployment
+# If you read this file, start docker compose with the following command:
+# bash start-docker.sh
+
+# Define network
+networks:
+  npm-dev-network:
+    name: npm-dev-network
+    driver: bridge
+    external: false
+
+# Define services
+services:
+  npm-dev-server:
+    image: node:22
+    user: node
+    working_dir: /app
+    volumes:
+      - ./html/:/app
+    ports:
+      - "3000:3000"
+    networks:
+      - npm-dev-network
+    entrypoint: [ "/bin/bash", "/app/entrypoint.sh" ]
+    healthcheck:
+      test: [ "CMD", "curl", "-f", "http://localhost:3000" ]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+    restart: unless-stopped

__tests__/ad.spec.ts → html/__tests__/ad.spec.ts

@@ -1,4 +1,4 @@
-import DateConverter from '../src/index';
+import DateConverter from '../src';
 
 import records from './data.json';
 

__tests__/bs.spec.ts → html/__tests__/bs.spec.ts

@@ -1,4 +1,4 @@
-import DateConverter from '../src/index';
+import DateConverter from '../src';
 
 import records from './data.json';
 

html/entrypoint.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# Exit on error
+set -e
+
+# Change to the app directory
+cd /app
+
+# Install dependencies
+npm install
+
+# Start the app
+npm run dev

index.html → html/index.html

@@ -1,11 +1,11 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <title>Console</title>
   </head>
   <body>
-    <script type="module" src="/src/index.ts"></script>
+    <script type="module" src="./src/index.ts"></script>
   </body>
 </html>

maker/package-manager.ts → html/maker/package-manager.ts

@@ -64,5 +64,3 @@ await writeFile(
 
 // Copy static files to the dist folder
 await copyFile('.npmrc', join(distPath, '.npmrc'));
-await copyFile('README.md', join(distPath, 'README.md'));
-await copyFile('LICENSE', join(distPath, 'LICENSE'));

package.json → html/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remotemerge/nepali-date-converter",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A modern JavaScript library for seamless conversion between Bikram Sambat (BS) and Gregorian (AD) dates. Easily convert Nepali dates to English dates and vice versa with support for years 1975 BS to 2099 BS.",
   "homepage": "https://madansapkota.com",
   "license": "MIT",
@@ -44,9 +44,9 @@
     "lint": "eslint **/*.ts",
     "lint:fix": "eslint **/*.ts --fix",
     "test": "jest",
-    "dev": "vite",
+    "dev": "vite --host 0.0.0.0 --port 3000",
     "preview": "vite preview",
-    "build": "vite build && npx tsx maker/package-manager.ts"
+    "build": "vite build && npx tsx ./maker/package-manager.ts"
   },
   "dependencies": {
     "date-fns": "^4.1.0"

start-docker.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+# Stop and remove orphan services
+docker compose --file ducker-compose.yml down --remove-orphans
+
+# Remove dangling services
+docker container prune -f
+docker network prune -f
+docker builder prune -f
+docker image prune -f
+docker volume prune -f
+
+# Start services
+docker compose --file ducker-compose.yml up