echo-service

Simple echo service

This is an echo service that will listen on 9595 and return a 200 OK

The PARALLELISM variable defaults to 2. Set an environment variable with the same name to change parallelism.

To build the docker image, execute docker build --tag echoservice:0.0.1 .

Development Setup

Prerequisites

• Node.js v22.15

Local Development

To set up the project locally:

1. Fork the repository on GitHub

2. Clone your fork:

git clone https://github.com/your-username/sunbird-echo-service.git
cd sunbird-echo-service

3. Install dependencies:

npm i

Code Quality

The project maintains code quality through automated checks that run on every pull request:

1. Linting

   • ESLint for code style and quality
   • Command: npm run lint

2. Dependencies

   • Uses npm ci for deterministic installations
   • GitHub Actions cache for faster builds

3. Code Formatting

   • Ensures consistent code formatting
   • Can be automatically fixed using npm run lint:fix

These checks ensure consistent code style and secure dependency management.

Container Image Publishing

This repository uses GitHub Actions to automatically build and publish Docker container images to GitHub Container Registry (GHCR) whenever a new tag is pushed to the repository.

Build and Publish Workflow

The workflow is triggered on:

• creation of any tag

Key features of the workflow:

1. Automatically builds Docker images
2. Tags images with a combination of:
   • The tag name (lowercased)
   • Short commit hash
   • GitHub run number
3. Publishes images to ghcr.io using the repository name
4. Uses GitHub Actions for secure authentication to GHCR

Image Naming Convention

The Docker images follow this naming convention:

• Repository: ghcr.io/${OWNER_NAME}/${REPO_NAME_LOWERCASE}
• Tag: ${TAG_NAME}_${COMMIT_HASH}_${RUN_NUMBER}

For example, if you push a tag v1.0.0 on commit abc123, the resulting image would be:

ghcr.io/project-sunbird/sunbird-echo-service:v1.0.0_abc123_1