Giter VIP home page Giter VIP logo

go-icndb's Introduction

go-icndb

This is a simple clone of Internet Chuck Norris DB. The scope of this project is to be a sample project that can be used for:

  • trainings
  • experiments e.g. with load testint tools
  • probably something else

Getting started

To start the API locally just start the container and publish the default port 3000.

docker run --rm -ti -p 3000:3000 ghcr.io/baez90/go-icndb:latest

Then start using it: http://localhost:3000. When opening the root of the app you're automatically redirected to a Swagger UI describing how to use the API.

Configuration

go-icndb being a nice 'cloud native'-ish application can be configured either via CLI flags or via environment variables.

Option CLI switch Env variable
Listen address --http.address ICNDB_HTTP_ADDRESS
Default first name --jokes.default-first-name ICNDB_JOKES_DEFAULT_FIRST_NAME
Default last name --jokes.default-last-name ICNDB_JOKES_DEFAULT_LAST_NAME

Observability

go-icndb exposes some observability related endpoints:

  • /health - basic health check, doesn't do much
  • /metrics - exposes Prometheus compliant metrics

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.