About

An example Node service with Docker & CI/CD using Github Actions.

The Node Express API defines two simple routes purely as an example. The /fish/:species route returns some sample data either from https://www.fishwatch.gov/api or from a Redis cache. The focus of this template is Docker/DockerHub and Github Actions, and most of the NodeJS code can be removed if not needed.

Docker is used to containerize this Node app and start it with any other services it depends on, in our example Redis. Two Github Actions have been created:

1. The run-unit-tests.yml action runs unit tests using Jest on every push or pull request to the main branch.
2. The build-image.yml action builds the production Docker image and pushes it to my Docker Hub account/project. You should have your own Docker Hub account and define your own "secrets" otherwise this won't work.

The build-image.yml Github action uses the Dockerfile to build a production image such as vasilionjea/fish-species-api:v1.0.2 and pushes that image to Docker Hub (vasilionjea maps to my username and fish-species-api to the repository on https://hub.docker.com). You must create your own account/repo and replace all references in the codebase.

The compose.yml file defines the production containerized services for our app and it's used by the docker compose up command to run these services. The prod service (our node app) uses a prod image from our Docker Hub account/project.

The compose.dev.yml file defines the containerized services for development and it's used when running the command docker compose -f compose.dev.yml up --build to build a development image and start the dev services. Docker volumes sync source code changes between the container and the host machine.

Development

Build & run in dev environment:

• Start: docker compose -f compose.dev.yml up --build -V
• Stop: docker compose -f compose.dev.yml down
• cURL or using Browser navigate to: http://localhost:3000/ or http://localhost:3000/fish/red-snapper

Testing

• Run and watch tests locally: npm test
• Run CI tests locally: npm run test:ci
• Run CI tests in container: docker compose -f compose.dev.yml up --build -V test or docker compose -f compose.dev.yml run --rm test

Production

Run service in prod:

• Start: docker compose up -d
• Stop: docker compose down

Run prod service from a locally built image:

• Build from local Dockerfile & start: docker compose up --build (compose.yml must have a build: ./ option)
• Stop: docker compose down
• Stop and delete volumes: docker compose down -v (-v also removes valumes)

Other

Container interaction:

• Enter app container's Bash: docker exec -it fish-species-api-prod bash
• Enter Redis container's bash: docker exec -it redis bash Then enter redis CLI: redis-cli

Release:

• Upgrade version: npm version patch -m "Bump version to %s" (choose between patch, minor, major)
• New images are released via the build-image.yml Github action.
• On every push images are tagged with the latest tag.
• When new version tags are pushed with npm version, images are tagged with the v*.*.* tag.

Deploy:

• TBD (depends on where... e.g. Google Cloud Run, Kubernetes, AWS, etc.)