https://github.com/mariuskimmina/supplywatch

Supplywatch is a distributed system trying to simulate a supplychain
https://github.com/mariuskimmina/supplywatch

Last synced: about 4 hours ago
JSON representation

Supplywatch is a distributed system trying to simulate a supplychain

• Host: GitHub
• URL: https://github.com/mariuskimmina/supplywatch
• Owner: mariuskimmina
• Created: 2022-02-09T07:58:02.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-02-14T07:29:31.000Z (almost 3 years ago)
• Last Synced: 2024-06-19T17:51:59.875Z (5 months ago)
• Language: Go
• Homepage:
• Size: 380 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Supplywatch

Supplywatch is a distributed system trying to simulate a supplychain.

It consists of:

* Sensors

    * Simulates random products (from a predefined list) entering or leaving a warehouse

* Warehouses

    * receives data from Sensors

    * stores the current amount of each product in a database

* Monitor

    * a central overview, here you can view the data of each warehouse

Warehouses can also ship products to other warehouses. When a warehouse has nothing left of any given product it will send

a message to all other warehouses (via MessageQueue) requesting said product. If any of the other warehouses has atleast

two units of that product left it will send one to the requesting warehouse (via gRPC).

## Architecture Diagramm

![Architecture Diagramm](media/images/architecture.png)

## Getting Started

First you need to adjust the configurations in `configurations/postgresql.env.dummy`

You can adjust all values but the only one you really should change is the `POSTGRES_PASSWORD`.

Once you are done editing save the file as `configurations/postgresql.env`

Afterwards you can start the project by simply running:

```

docker-compose up -d --build

```

## Project Structure

* `build/`: defines the infrastructure

  * `/`: define a Dockerfile for the concrete service.

* `configurations/`: config files

* `charts/`: Helm Chart for kubernetes deployment

* `cmd/`: entrypoints

  * `/`: primary entrypoint for this service - short main functions.

* `configurations/`: config files

* `internal/`: defines the _core domain_.

  * `/`: concrete implementation of the service - source code.

  * `pb`: generated code from protobuf definitions

* `media/`: images

* `pkg/`: code that is used by multiple services.

* `proto/`: protobuf files for gRPC

* `tests/`: Scripts to test functionality

## Kubernetes deployment

To make the deployment of the system as easy as possible, a helm chart has been provided

Assuming that helm is installed on your system and has been setup to communicate with your cluster you can simply run:

```

helm install supplywatch-service

```