feat: docker updates

Author: kunwarVivek

.dockerignore

@@ -0,0 +1,51 @@
+# Docker Support
+
+This project includes Docker support to make deployment and development easier.
+
+## Prerequisites
+
+- Docker installed on your system
+- GitHub token, owner, and repository information for the `.env` file
+
+## Environment Variables
+
+Make sure to set the following environment variables in your `.env` file:
+
+```
+GITHUB_TOKEN=your_github_token
+GITHUB_OWNER=your_github_username_or_organization
+GITHUB_REPO=your_repository_name
+```
+
+## Building the Docker Image
+
+```bash
+docker build -t mcp-github-project-manager .
+```
+
+## Running the Container
+
+```bash
+# Run the container with your .env file
+docker run -it --env-file .env mcp-github-project-manager
+
+# Alternatively, you can provide environment variables directly
+docker run -it \
+  -e GITHUB_TOKEN=your_github_token \
+  -e GITHUB_OWNER=your_github_username_or_organization \
+  -e GITHUB_REPO=your_repository_name \
+  mcp-github-project-manager
+```
+
+## Development with Docker
+
+For development purposes, you can mount your local source directory into the container:
+
+```bash
+docker run -it \
+  --env-file .env \
+  -v $(pwd)/src:/app/src \
+  mcp-github-project-manager
+```
+
+This allows you to make changes to your source code and see them reflected in the container.

DOCKER.md

@@ -0,0 +1,33 @@
+# Use Node.js 18 as the base image (matches your package.json engine requirement)
+FROM node:18-alpine
+
+# Create app directory
+WORKDIR /app
+
+# Install pnpm (since your project uses pnpm-lock.yaml)
+RUN npm install -g pnpm
+
+# Copy package.json, pnpm-lock.yaml and other configuration files
+COPY package.json pnpm-lock.yaml tsconfig.json tsconfig.build.json ./
+
+# Install dependencies
+RUN pnpm install --frozen-lockfile
+
+# Copy source code and other necessary files
+COPY src/ ./src/
+COPY .env.example ./.env.example
+
+# Build the project
+RUN pnpm build
+
+# Create a .env file if one doesn't exist
+RUN if [ ! -f .env ]; then cp .env.example .env || echo "No .env.example found"; fi
+
+# Expose any ports your application might need (optional)
+# EXPOSE 3000
+
+# Set environment variables
+ENV NODE_ENV=production
+
+# Start the MCP server
+CMD ["node", "build/index.js"]

Dockerfile

@@ -10,6 +10,37 @@ A Model Context Protocol (MCP) server implementation that provides GitHub Projec
 
 This server implements the [Model Context Protocol](https://modelcontextprotocol.io) to expose GitHub Projects functionality to LLM clients and applications. It provides tools for managing projects, milestones, sprints, and metrics through GitHub's GraphQL API while maintaining state and handling errors according to MCP specifications.
 
+## Quick Start
+
+### Using NPM
+```bash
+# Install the package globally
+npm install -g mcp-github-project-manager
+
+# Set up your environment variables
+export GITHUB_TOKEN="your_github_token"
+export GITHUB_OWNER="your_github_username_or_organization"
+export GITHUB_REPO="your_repository_name"
+
+# Run the MCP server
+mcp-github-project-manager
+```
+
+### Using Docker
+```bash
+# Build the Docker image
+docker build -t mcp-github-project-manager .
+
+# Run with environment variables
+docker run -it \
+  -e GITHUB_TOKEN=your_github_token \
+  -e GITHUB_OWNER=your_github_username_or_organization \
+  -e GITHUB_REPO=your_repository_name \
+  mcp-github-project-manager
+```
+
+For more details on Docker usage, see [DOCKER.md](DOCKER.md).
+
 ## Key Features
 
 - **Project Management**

README.md

@@ -0,0 +1,34 @@
+# Dependencies
+node_modules
+npm-debug.log
+pnpm-debug.log
+yarn-debug.log
+yarn-error.log
+
+# Build output
+build
+
+# Testing
+coverage
+
+# Environment variables
+.env
+
+# Version control
+.git
+.gitignore
+
+# IDE files
+.idea
+.vscode
+*.sublime-workspace
+*.sublime-project
+
+# Temporary files
+tmp
+.tmp
+*.log
+
+# OS generated files
+.DS_Store
+Thumbs.db