Skip to content

michaelrechani/hello-service

 
 

Repository files navigation

Hello service

GitHub License: MIT Gitpod: ready-to-code

Mergify Status Maintenance status: best-effort

Proof-of-Concept (PoC) application that calls 2 other services.

For example for "Hello world!" this app would be the one providing calling 2 services to get "Hello" and "world", and it would add the "!" at the end.

Architecture diagram showing the flow: Hello service, a React app, calls Greeting service to get a greeting (eg "hello") and calls Naming service to get a name (eg "world"). Hello service then adds the answer together for the final result: "Hello World!"

Intended use

The purpose of this application is to be used for microservices tech demos and example implementations of tools.

It is in no way, shape, or form a reference for best practices, a good example, or a comprehensive anything. It is a minimal skeleton app with simple logic that can easily be extended.

For more complex demos see:

Usage

This repository is configured with support for GitPod for easy development.

Local application commands:

npm ci # to install all dependencies

npm build # to build the app

npm start # to run the app (if not already running)

Docker commands, with the mention that you really should not put this in a container:

docker run --interactive --tty --rm \
  --publish 3000:3000 \
  public.ecr.aws/poc-hello-world/hello-service:latest

Configuration and forking

This repository is fork-friendly!

  • fork this repository
  • go to the "Actions" tab and enable GitHub Actions
  • setup relevant secrets
    • to build and push a container image to Amazon ECR
      • AWS_ACCESS_KEY_ID looking something like AKIAIOSFODNN7EXAMPLE
      • AWS_SECRET_ACCESS_KEY looking something like wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
  • change relevant values in .github/workflows/app-build-and-push.yaml
  • change something in the code and create a new Pull Request

Forks

If you extend this application to do something, please create a Pull Request back with a link to your fork.

Fork link Extras added

License

This project is provided under the MIT License. See LICENSE for more information.

Credits

Special credits go to @adaschevici for writing this. Thank you!

About

PoC that composes a 'Hello World' message by calling 2 other services

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 46.3%
  • CSS 34.7%
  • HTML 13.4%
  • Shell 3.9%
  • Dockerfile 1.7%