zio/zio-quickstarts

A minimal quickstart ZIO application for writing a RESTful Web Service

ZIO Quickstarts

This repository contains a collection of quickstarts for ZIO. Each quickstart is a self-contained project that demonstrates a particular aspect of ZIO. The quickstarts are designed to be easy to run and explore.

To learn about each quickstart, we have a dedicated article about it at the ZIO documentation website. You can find the list of quickstart articles here.

Running Quickstarts

First, open the console and clone the project using git (or you can simply download the project) and then to the directory of the quickstart you want to run, e.g. zio-quickstart-restful-webservice:

$ git clone https://github.com/zio/zio-quickstarts.git
$ cd zio-quickstarts/zio-quickstart-restful-webservice

Once you are inside the project directory, run the application:

$ sbt run

List of Quickstarts

• ZIO Cache
• ZIO Json
• ZIO GraphQL Webservice
• ZIO Hello World
• ZIO JUnit Tests
• ZIO Kafka
• ZIO Prelude
• ZIO Reloadable Service
• ZIO RESTful webservice
• ZIO RESTful webservice with configs
• ZIO RESTful webservice with default logger
• ZIO RESTful webservice with custom logger
• ZIO RESTful webservice with docker
• ZIO RESTful webservice with metrics
• ZIO STM - many thanks to @jorge-vasquez-2301 and his article for this example
• ZIO SQL
• ZIO Streams

zio-quickstarts's Issues

ZIO Tests for restful webservices

Hello, is there any chance that you could include ZIO tests to the restful webservices project, with examples that use POST with a body payload?

Quickstarts That Need to Be Included

We need to cover these topics:

• ZIO STM
• Using ZIO With Scala Native
• Using ZIO With ScalaJS
• ZIO and SQL
• ZIO Cache
• ZIO Query
• ZIO Prelude
• ZIO Schema

quickstarts

When trying to sbt run on zio-quickstarts/zio-quickstart-restful-webservice it can't resolve the scala 3 libs.

Turns out the sbt version is OLD. Try upgrading to 1.9.0 in project/build.properties and it resolves scala 3 libs just fine.

error when "sbt run"

Envirionment

Windows 10 Pro Version 2009

$ > java --version
java 20 2023-03-21
Java(TM) SE Runtime Environment (build 20+36-2344)
Java HotSpot(TM) 64-Bit Server VM (build 20+36-2344, mixed mode, sharing)

scala --version
Scala code runner version 3.2.2 -- Copyright 2002-2023, LAMP/EPFL

I run "sbt run" in ".\zio-quickstart-hello-world" directory
but error occurs like this

[info] welcome to sbt 1.8.2 (Oracle Corporation Java 20)
[info] loading project definition from J:\project\study\fp-libraries\zio-quickstarts\zio-quickstart-hello-world\project
J:\project\study\fp-libraries\zio-quickstarts\zio-quickstart-hello-world\build.sbt:3: error: not found: value stdSettings
    .settings(stdSettings())
              ^
J:\project\study\fp-libraries\zio-quickstarts\zio-quickstart-hello-world\build.sbt:4: error: not found: value enableZIO
    .settings(enableZIO())
              ^
sbt.compiler.EvalException: Type error in expression
[error] sbt.compiler.EvalException: Type error in expression
[error] Use 'last' for the full log.
[warn] Project loading failed: (r)etry, (q)uit, (l)ast, or (i)gnore? (default: r)

What I am missing ?
thank you

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update dependency dev.zio:zio-http to v3.0.0-RC3
• Update dependency scala to v2.13.12
• Update dependency com.github.ghostdogpr:caliban to v2.4.3
• Update dependency com.github.ghostdogpr:caliban-zio-http to v2.4.3
• Update dependency dev.zio:zio-metrics-connectors to v2.2.1
• Update dependency io.getquill:quill-jdbc-zio to v4.8.0
• Update dependency io.getquill:quill-zio to v4.8.0
• Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• Update dependency io.d11:zhttp to v2.0.0-RC11

Detected dependencies

docker-compose

zio-quickstart-kafka/docker-compose.yml

sbt

build.sbt

• scala 2.13.8

project/build.properties

• sbt/sbt 1.9.7

project/plugins.sbt

• com.github.sbt:sbt-native-packager 1.9.16
• ch.epfl.scala:sbt-scalafix 0.11.1

zio-quickstart-encode-decode-json/build.sbt

• scala 2.13.8
• dev.zio:zio 2.0.19
• dev.zio:zio-test 2.0.19
• dev.zio:zio-json 0.6.2

zio-quickstart-graphql-webservice/build.sbt

• scala 2.13.8
• dev.zio:zio 2.0.19
• com.github.ghostdogpr:caliban 2.0.0
• com.github.ghostdogpr:caliban-zio-http 2.0.0
• io.d11:zhttp 2.0.0-RC10

zio-quickstart-hello-world/build.sbt

• scala 2.13.8
• dev.zio:zio 2.0.19

zio-quickstart-junit-integration/build.sbt

• scala 2.13.8
• dev.zio:zio 2.0.19
• dev.zio:zio-test 2.0.19
• dev.zio:zio-test-sbt 2.0.19
• dev.zio:zio-test-junit 2.0.19
• com.github.sbt:junit-interface 0.13.3

zio-quickstart-kafka/build.sbt

• dev.zio:zio-kafka 2.6.0
• dev.zio:zio-json 0.6.2

zio-quickstart-reloadable-services/build.sbt

• scala 2.13.8
• dev.zio:zio 2.0.19
• dev.zio:zio-macros 2.0.19

zio-quickstart-restful-webservice-configurable-app/build.sbt

• scala 2.13.8
• dev.zio:zio 2.0.19
• dev.zio:zio-json 0.6.2
• dev.zio:zio-http 3.0.0-RC2
• io.getquill:quill-zio 4.7.0
• io.getquill:quill-jdbc-zio 4.7.0
• com.h2database:h2 2.2.224
• dev.zio:zio-config 4.0.0-RC16
• dev.zio:zio-config-typesafe 4.0.0-RC16
• dev.zio:zio-config-magnolia 4.0.0-RC16

zio-quickstart-restful-webservice-custom-logger/build.sbt

• scala 2.13.8
• dev.zio:zio 2.0.19
• dev.zio:zio-json 0.6.2
• dev.zio:zio-http 3.0.0-RC2
• io.getquill:quill-zio 4.7.0
• io.getquill:quill-jdbc-zio 4.7.0
• com.h2database:h2 2.2.224
• dev.zio:zio-logging 2.1.15
• dev.zio:zio-logging-slf4j 2.1.15
• org.slf4j:slf4j-simple 2.0.9

zio-quickstart-restful-webservice-dockerize/build.sbt

• scala 2.13.8
• dev.zio:zio 2.0.19
• dev.zio:zio-json 0.6.2
• dev.zio:zio-http 3.0.0-RC2
• io.getquill:quill-zio 4.7.0
• io.getquill:quill-jdbc-zio 4.7.0
• com.h2database:h2 2.2.224

zio-quickstart-restful-webservice-dockerize/project/build.properties

• sbt/sbt 1.9.7

zio-quickstart-restful-webservice-logging/build.sbt

• scala 2.13.8
• dev.zio:zio 2.0.19
• dev.zio:zio-json 0.6.2
• dev.zio:zio-http 3.0.0-RC2
• io.getquill:quill-zio 4.7.0
• io.getquill:quill-jdbc-zio 4.7.0
• com.h2database:h2 2.2.224

zio-quickstart-restful-webservice-metrics/build.sbt

• scala 2.13.8
• dev.zio:zio 2.0.19
• dev.zio:zio-metrics-connectors 2.0.8
• dev.zio:zio-json 0.6.2
• dev.zio:zio-http 3.0.0-RC2
• io.getquill:quill-zio 4.7.0
• io.getquill:quill-jdbc-zio 4.7.0
• com.h2database:h2 2.2.224

zio-quickstart-restful-webservice/build.sbt

• scala 3.3.1
• dev.zio:zio 2.0.19
• dev.zio:zio-json 0.6.2
• dev.zio:zio-http 3.0.0-RC2
• io.getquill:quill-zio 4.7.0
• io.getquill:quill-jdbc-zio 4.7.0
• com.h2database:h2 2.2.224

zio-quickstart-streams/build.sbt

• scala 2.13.8
• dev.zio:zio 2.0.19
• dev.zio:zio-test 2.0.19
• dev.zio:zio-streams 2.0.19

---

• Check this box to trigger a request for Renovate to run again on this repository