https://github.com/geirolz/fp-microservice

A purely functional microservice template in Scala
https://github.com/geirolz/fp-microservice

cats distributed-systems fp functional-programming kafka microservice scala template

Last synced: 2 months ago
JSON representation

A purely functional microservice template in Scala

• Host: GitHub
• URL: https://github.com/geirolz/fp-microservice
• Owner: geirolz
• Created: 2021-04-30T12:20:59.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-08T00:28:51.000Z (4 months ago)
• Last Synced: 2024-10-16T16:46:00.380Z (3 months ago)
• Topics: cats, distributed-systems, fp, functional-programming, kafka, microservice, scala, template
• Language: Scala
• Homepage: https://geirolz.github.io/fp-microservice/
• Size: 620 KB
• Stars: 12
• Watchers: 3
• Forks: 1
• Open Issues: 45
• Metadata Files:
  • Readme: README.md
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
## Purely Functional HTTP microservice

[![Build Status](https://github.com/geirolz/fp-microservice/actions/workflows/cicd.yml/badge.svg)](https://github.com/geirolz/fp-microservice/actions)

[![Scala Steward](https://img.shields.io/badge/Scala_Steward-helping-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAA4AAAAQCAMAAAARSr4IAAAAVFBMVEUAAACHjojlOy5NWlrKzcYRKjGFjIbp293YycuLa3pYY2LSqql4f3pCUFTgSjNodYRmcXUsPD/NTTbjRS+2jomhgnzNc223cGvZS0HaSD0XLjbaSjElhIr+AAAAAXRSTlMAQObYZgAAAHlJREFUCNdNyosOwyAIhWHAQS1Vt7a77/3fcxxdmv0xwmckutAR1nkm4ggbyEcg/wWmlGLDAA3oL50xi6fk5ffZ3E2E3QfZDCcCN2YtbEWZt+Drc6u6rlqv7Uk0LdKqqr5rk2UCRXOk0vmQKGfc94nOJyQjouF9H/wCc9gECEYfONoAAAAASUVORK5CYII=)](https://gitlab.com/moneyfarm-tech/sandbox/steward)

[![Mergify Status](https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/geirolz/fp-microservice&style=flat)](https://mergify.io)

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/5c46a629cc5d447ca3d1e36ad776ba19)](https://www.codacy.com/gh/geirolz/fp-microservice/dashboard?utm_source=github.com&utm_medium=referral&utm_content=geirolz/fp-microservice&utm_campaign=Badge_Grade)

Simple POC for dockerized HTTP microservice using Scala in a functional programming way.

1. [Prerequisites](#Prerequisites)

2. [Stack](#Stack)

3. [Usage](#Usage)

4. [Customize](#Customize)

5. [Roadmap](#Roadmap)

## Prerequisites

- JDK 17 (jenv can help)

- SBT

- Docker

- Minikube

- Terraform

## Stack

### Application stack

| SCOPE                               | TECH                                                                     |

|-------------------------------------|--------------------------------------------------------------------------|

| ✅ Effects                           | [cats-effect](https://github.com/typelevel/cats-effect)                  |

| ✅ Logging                           | [log4cats](https://github.com/typelevel/log4cats)                        |

| ✅ Jdbc (plain, transactions, etc..) | [doobie](https://github.com/tpolecat/doobie)                             |

| ✅ Db migration                      | [fly4s](https://github.com/geirolz/fly4s)                                |

| ✅ Http client and server            | [http4s](https://github.com/http4s/http4s)                               |

| ✅ Http route definitions            | [tapir](https://github.com/softwaremill/tapir)                           |

| ✅ Config                            | [pureconfig](https://github.com/pureconfig/pureconfig)                   |

| ✅ Json                              | [circe](https://github.com/circe/circe)                                  |

| ✅ Refinement types                  | [refined](https://github.com/fthomas/refined)                            |                        |

| ⬜ Unit tests                        | [munit](https://github.com/scalameta/munit)                              |

| ⬜ IT tests                          | [testcontainers](https://github.com/testcontainers/testcontainers-scala) |

### Infrastructure stack

| SCOPE                     | TECH                                                                                 |

|---------------------------|--------------------------------------------------------------------------------------|

| ⬜ Project as template     | [g8](http://www.foundweekends.org/giter8/)                                           |

| ✅ Containerized app       | [Docker](https://www.docker.com/) via [DockerSbt](https://github.com/sbt/docker-sbt) |

| ⬜ Containers orchestrator | [K8s](https://kubernetes.io/)                                                        |

| ⬜ Service mesh            | [Istio](https://istio.io/)                                                           |

## Local Usage

First of all you have to publish the docker image of the app into your local repository with 

```shell

./deployLocalDockerImage.sh

```

Then you can choose to either run the app with `docker-compose` or `minikube`.

### Docker

Run the deploy script to run the app and the database with docker-compose

```shell

.infra/local/docker-compose/deploy.sh

```

> ⚠️ **You should use `http`** and not `https` beware that Chrome by default use `https`

### Minikube

Run the deploy script to run the app and the database with minikube.

Services are not port forwarded by default.

```shell

.infra/local/minikube/deploy.sh

```

## Customize

To customize this project please read the [guide](doc/guide.md)