RoundMap

Containerization and Deployment

This project is containerized using Docker and can be deployed using GitHub Actions CI/CD.

Local Development with Docker

Prerequisites

• Docker
• Docker Compose

Development Mode

To run the application in development mode with hot-reloading:

docker-compose up dev

This will start the application in development mode on http://localhost:3000.

Production Mode

To build and run the application in production mode:

docker-compose up prod

This will build the application and start it in production mode on http://localhost:3000.

Building Docker Images Manually

Development Image

docker build -t roundmap:dev -f Dockerfile.dev .
docker run -p 3000:3000 -v $(pwd):/app -v /app/node_modules roundmap:dev

Production Image

docker build -t roundmap:latest .
docker run -p 3000:3000 roundmap:latest

CI/CD with GitHub Actions

This project uses GitHub Actions for continuous integration and deployment. The workflow is defined in .github/workflows/docker-deploy.yml.

How it works

1. When you push to the main branch, GitHub Actions will:
   • Build the Docker image
   • Push it to GitHub Container Registry (ghcr.io)
   • Deploy it to your production server

Setting up deployment to a self-hosted server

The GitHub Actions workflow has been configured to deploy to a server. To make this work:

1. Add the following secrets to your GitHub repository:

   • SSH_HOST: IP address of the server
   • SSH_USER: Username to access the server
   • SSH_PRIVATE_KEY: Your private SSH key for accessing the server
   • SSH_KNOWN_HOSTS: The SSH known hosts entry for your server (run ssh-keyscan ${SSH_HOST} to generate)

2. The workflow will:

   • Build the Docker image
   • Push it to GitHub Container Registry (ghcr.io)
   • SSH into your server
   • Pull the latest image
   • Stop and remove any existing container
   • Start a new container with the latest image
   • Clean up old images