https://github.com/bitbrain/coffeeshop
Spring 5 🍃 + Kubernetes ⚓ + Terraform 🌱
https://github.com/bitbrain/coffeeshop
docker kubernetes reactive-streams spring-boot terraform
Last synced: 3 months ago
JSON representation
Spring 5 🍃 + Kubernetes ⚓ + Terraform 🌱
- Host: GitHub
- URL: https://github.com/bitbrain/coffeeshop
- Owner: bitbrain
- License: apache-2.0
- Created: 2018-10-18T08:16:00.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-18T18:42:17.000Z (over 7 years ago)
- Last Synced: 2025-02-13T23:36:12.310Z (about 1 year ago)
- Topics: docker, kubernetes, reactive-streams, spring-boot, terraform
- Language: Java
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ☕️🥐 coffeeshop
> Spring 5 + Kubernetes + Terraform
This demo application showcases how to use a [Reactive Web Application based on Spring 5](https://docs.spring.io/spring/docs/5.0.0.BUILD-SNAPSHOT/spring-framework-reference/html/web-reactive.html), deployed via [Terraform](https://terraform.io) onto a [Kubernetes](https://kubernetes.io) cluster.
## Prequisites
You need to install the following on your system to run this demo:
* 🐳 [Docker](https://www.docker.com)
* ⚓️ [Kubernetes](https://kubernetes.io)
## Install
To run the application, execute:
```bash
./start-coffeeshop.sh
```
## Introduction
Welcome to **CoffeeShop** - we offer freshly brewed coffee, cakes and delicious sandwiches. Demand grew a lot which made us move into the cloud. Our architecture allows us to take orders online via an API, we store our orders and can present them to our employees.
## Project Structure
This project consists of the following folders:
* `api/` - the frontend API component to serve requests from shops and clients
* `orderbook/` - the order component of the system
* `catalogue/` - the product catalogue of the coffeeshop
* `infrastructure/` - the infrastructure required, for example a `MongoDB` database, running via `docker-compose`.
Additionally, this project contains the following files:
* `start-coffeeshop.sh` - starts the entire coffeeshop in a local Kubernetes cluster
## Data Model
This demo consists of a data model like this:
* **product** a product is any product offered by the coffee shop.
* **order** an order always references a product which has been ordered. Optionally, we can expose the status on that order.
## Architecture
The following diagram describes a high level architecture of this demo:
Our barista uses a client (smartphone app or desktop app) to configure an order for a given customer. For example, if a customer
orders a *coffee*, the barista creates that order in the system. The API client then
makes a call to the API to create that order. Once the coffee is finished, the barista
presses a button on the app to confirm that the order is complete.
In order to find out details about each component, refer to the respective documentation of
each component:
* [api](api/README.md)
* [catalogue](catalogue/README.md)
* [orderbook](orderbook/README.md)
## Credits
This demo has been designed and built by [Miguel Gonzalez Sanchez](https://bitbrain.github.io). Make sure you follow me on Twitter [@bitbrain](https://twitter.com/bitbrain).