Skip to content

Commit

Permalink
Remove unused code, tidy readme (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
RawToast authored Mar 16, 2024
1 parent c0704c8 commit 3dbc9c5
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 62 deletions.
21 changes: 12 additions & 9 deletions server/readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Http4s Twirl Example
# Manjuu Server

![ci](https://github.com/rawtoast/http4s-twirl-example/actions/workflows/ci.yml/badge.svg)

This application is an example of using Http4s, Blaze Client, Circe and Twirl templates -- including example unit and template tests.
This application is a simple backend example using Http4s, Redis, and Circe -- including some example unit tests.
The initial goal was to rework my old [http4s-twirl-example](https://github.com/RawToast/http4s-twirl-example)
to use Scala 3, as a backend for some frontend work.


## Running this app

Expand All @@ -11,18 +14,18 @@ To start: `sbt run` this will run the service on port 8080

## Running tests

An alias has been provided to run all tests with coverage: `sbt validate` the html report can be located
at `target/scala-2.12/scoverage-report/index.html`
An alias has been provided to run all tests with coverage: `sbt codeCoverage` the html report can be located
at `target/scala-3.4.0/scoverage-report/index.html`


## Tech Stack

This api is built on the following Scala / Java open source libraries:
This api is built on the following Scala stack:

* [Scala 3](https://www.scala-lang.org)
* [Http4s](http://http4s.org)
* [Circe](https://circe.github.io/circe)
* [Cats](http://typelevel.org/cats)
* [Twirl](https://github.com/playframework/twirl)
* [ScalaTest](http://www.scalatest.org)
* [Mockito](http://site.mockito.org)
* [WireMock](http://wiremock.org)
* [Cats Effect](http://typelevel.org/cats-effect)
* [Redis4Cats](http://redis4cats.profunktor.dev)
* [Munit](http://scalameta.org/munit)
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import dev.profunktor.redis4cats.effect.Log.Stdout.given
import io.circe.{Json, JsonObject}
import io.circe.parser.{decode => jsonDecode}
import io.circe.syntax._
import org.http4s.headers.`Access-Control-Max-Age`.Cache
import scala.concurrent.duration.FiniteDuration

trait Cache[F[_], K, V]:
Expand Down
49 changes: 0 additions & 49 deletions server/src/main/scala/manjuu/middleware/CachingMiddleware.scala

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
package manjuu.routes

import manjuu.domain._
import manjuu.services.AuthorityService
import manjuu.services.EstablishmentService
import manjuu.services.EstablishmentServiceError
import manjuu.services._

import cats.Monad
import cats.effect._
Expand Down

0 comments on commit 3dbc9c5

Please sign in to comment.