Feat/docker

* add docker and docker-compose file

* docs: 📝 add docker related information

Author: nabadeep25

.dockerignore

@@ -0,0 +1,12 @@
+node_modules
+dist
+.gitignore
+.env
+Dockerfile
+REAME.md
+.github
+bin
+coverage
+*.log
+.DS_Store
+docker-compose.yml

.env.example

@@ -1,7 +1,7 @@
 DB_HOST=localhost
 DB_NAME=name
 DB_PASSWORD=password
-DB_PORT=3306
+DB_PORT=5432
 DB_TYPE=postgres
 DB_USER=username
 PORT=5000

.github/workflows/npm-publish.yml

@@ -14,7 +14,6 @@ jobs:
         with:
           node-version: 20
           registry-url: https://registry.npmjs.org/
-      - run: npm ci
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

Dockerfile

@@ -0,0 +1,18 @@
+FROM node:20-alpine AS builder
+WORKDIR /app
+COPY package*.json ./
+RUN npm install
+COPY . .
+RUN npm run build
+
+FROM node:20-alpine
+WORKDIR /app
+COPY --from=builder /app/dist ./dist
+COPY package*.json ./
+# install postgres dependencies
+RUN npm install  pg pg-hstore 
+RUN npm install --only=production
+ENV NODE_ENV=production
+COPY . .
+EXPOSE 5000
+CMD ["npm", "start"]

README.md

@@ -19,6 +19,9 @@ A boilerplate/starter project for quickly building RESTful APIs using Node.js,Ty
   - [Manual Installation](#manual-installation)
   - [Getting started](#getting-started)
   - [For development](#for-development)
+  - [Docker Setup](#docker-setup)
+    - [Using Docker Compose (Recommended)](#using-docker-compose-recommended)
+    - [Using Docker Only](#using-docker-only)
   - [Sample .ENV](#sample-env)
   - [Commands](#commands)
   - [Project Structure](#project-structure)
@@ -84,6 +87,113 @@ npm run dev
 
 ```
 
+## Docker Setup
+
+### Using Docker Compose (Recommended)
+
+The easiest way to run the application with Docker is using Docker Compose, which will set up both the Node.js application and PostgreSQL database.
+
+1. **Create a `.env` file** in the project root:
+
+```bash
+# Database Configuration
+DB_HOST=postgres
+DB_PORT=5432
+DB_TYPE=postgres
+DB_NAME=myapp
+DB_USER=postgres
+DB_PASSWORD=password
+
+# JWT Configuration
+SECRET=your-secret-key-change-this-in-production
+TOKEN_EXPIRY_HOUR=24
+
+# Email Configuration
+EMAIL_SERVICE=gmail
+EMAIL_USER=your-email@gmail.com
+EMAIL_PASS=your-email-password
+EMAIL_FROM=your-email@gmail.com
+
+# OTP Configuration
+OTP_EXPIRY_MIN=5
+OTP_SECRET=your-otp-secret-change-this-in-production
+```
+
+2. **Build and run the containers**:
+
+```bash
+# Build and start all services
+docker compose up --build
+
+# Run in detached mode (background)
+docker compose up -d --build
+
+# Stop the services
+docker compose down
+
+```
+
+3. **Access the application**:
+   - **API**: http://localhost:5000/api/
+   - **Swagger Documentation**: http://localhost:5000/api/v1/docs/
+   - **Database**: PostgreSQL on localhost:5432
+
+### Using Docker Only
+
+If you prefer to run only the application container and connect to an external database:
+
+1. **Build the Docker image**:
+
+```bash
+docker build -t typescript-node-app .
+```
+
+2. **Run the container**:
+
+```bash
+docker run -p 5000:5000 \
+  -e DB_HOST=your-db-host \
+  -e DB_PORT=5432 \
+  -e DB_TYPE=postgres \
+  -e DB_NAME=your-db-name \
+  -e DB_USER=your-db-user \
+  -e DB_PASSWORD=your-db-password \
+  -e SECRET=your-secret-key \
+  -e TOKEN_EXPIRY_HOUR=24 \
+  -e EMAIL_SERVICE=gmail \
+  -e EMAIL_USER=your-email@gmail.com \
+  -e EMAIL_PASS=your-email-password \
+  -e EMAIL_FROM=your-email@gmail.com \
+  -e OTP_EXPIRY_MIN=5 \
+  -e OTP_SECRET=your-otp-secret \
+  typescript-node-app
+```
+
+
+### Docker Commands
+
+```bash
+# Build the image
+docker build -t typescript-node-app .
+
+# Run container
+docker run -p 5000:5000 typescript-node-app
+
+# Run with environment file
+docker run -p 5000:5000 --env-file .env typescript-node-app
+
+# View running containers
+docker ps
+
+# View logs
+docker logs <container-id>
+
+# Stop container
+docker stop <container-id>
+
+```
+
+
 ## Sample .ENV
 ```sh
 DB_HOST=localhost
@@ -128,6 +238,9 @@ npm run lint
 #  format files
 npm run format
 
+# Docker commands
+docker compose up --build
+docker compose down
 ```
 
 
@@ -149,6 +262,9 @@ src\
  |--validations\    # Request data validation schemas
  |--app.ts\         # Express app
  |--server.ts\      # App entry point
+docker-compose.yml  # Docker Compose configuration
+Dockerfile          # Docker image definition
+.env                # Environment variables
 ```
 ## Changing Database
 

docker-compose.yml

@@ -0,0 +1,47 @@
+version: '3.8'
+
+services:
+  app:
+    build: .
+    ports:
+      - "5000:5000"
+    env_file:
+      - .env
+    environment:
+      - NODE_ENV=production
+      # Database Configuration
+      - DB_HOST=${DB_HOST}
+      - DB_PORT=${DB_PORT}
+      - DB_TYPE=${DB_TYPE}
+      - DB_NAME=${DB_NAME}
+      - DB_USER=${DB_USER}
+      - DB_PASSWORD=${DB_PASSWORD}
+      # JWT Configuration
+      - SECRET=${SECRET}
+      - TOKEN_EXPIRY_HOUR=${TOKEN_EXPIRY_HOUR}
+      # Email Configuration
+      - EMAIL_SERVICE=${EMAIL_SERVICE}
+      - EMAIL_USER=${EMAIL_USER}
+      - EMAIL_PASS=${EMAIL_PASS}
+      - EMAIL_FROM=${EMAIL_FROM}
+      # OTP Configuration
+      - OTP_EXPIRY_MIN=${OTP_EXPIRY_MIN}
+      - OTP_SECRET=${OTP_SECRET}
+      # Port Configuration
+      - PORT=5000
+    depends_on:
+      - postgres
+
+  postgres:
+    image: postgres:16.0-alpine3.17
+    ports:
+      - "5432:5432"
+    environment:
+      - POSTGRES_USER=${DB_USER}
+      - POSTGRES_PASSWORD=${DB_PASSWORD}
+      - POSTGRES_DB=${DB_NAME}
+    volumes:
+      - postgres_data:/var/lib/postgresql/data
+
+volumes:
+  postgres_data:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nabadeep25/create-ts-node-app",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "A boilerplate/starter project for quickly building RESTful APIs using Node.js,Typescript, Express, and Sequelize.",
   "author": "Nabadeep Thakuria",
   "bin": "bin/cli.js",

src/server.ts

@@ -11,7 +11,7 @@ if (process.env.NODE_ENV === "development") {
 /**
  * Start Express server.
  */
-const server = app.listen(app.get("port"), () => {
+const server = app.listen(app.get("port"),"0.0.0.0",() => {
   console.log(
     "  App is running at http://localhost:%d in %s mode",
     app.get("port"),