# Getting started

# Overview

D4S is a Scala library to work with DynamoDB.
D4S is powered by Izumi (opens new window)
D4S uses Bifunctor IO and allows you to choose whatever effect type you want to use.
D4S provides flexible and extensible DSL
D4S supports AWS SDK v2
D4S has great integration with ZIO (opens new window) and Monix-BIO (opens new window).

# Dependencies

To use D4S, add the following line in your build.sbt file:

libraryDependencies += "net.playq" %% "d4s" %% "1.0.13"

The following modules are optional:
In case you want to have Circe codecs you should also add this:

libraryDependencies += "net.playq" %% "d4s-circe" %% "1.0.13"

If you want to use the metrics package from d4s you can add it like this:

libraryDependencies += "net.playq" %% "metrics" %% "1.0.13"

# How to learn

# Prerequisites

We assume you are comfortable with Amazon's DynamoDB.
We assume you are comfortable with functional programming concepts, including bifunctor IO and tagless-final encoding. Prior experience with Izumi (opens new window) or libraries like ZIO (opens new window), cats (opens new window), cats-effect (opens new window), FS2 (opens new window) would be helpful.

# Learning resources

Try our tutorial

Other resources:

Check out a talk (opens new window) about d4s on ScalaUA2020

# How to contribute

If you find a bug, open an issue (or fix it and open a PR) at our GitHub Repository.
If you want to make a larger contribution please open an issue first, so we can discuss.