diff --git a/README.md b/README.md index e4a557e8..190dde6d 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,39 @@ +# API Hub Frontend -# api-hub-frontend +This service provides a frontend for the API Hub. -This is a placeholder README.md for a new repository +## Summary -### License +This service provides the following functionality: -This code is open source software licensed under the [Apache 2.0 License]("http://www.apache.org/licenses/LICENSE-2.0.html"). \ No newline at end of file +* tbd + +## Requirements + +This service is written in [Scala](http://www.scala-lang.org/) and [Play](http://playframework.com/), so needs at least a [JRE] to run. + +## Run the application + +To run the application use `sbt run` to start the service. All local dependencies should be running first: +* MongoDb +* The API_HUB_ALL Service Manager group + +Once everything is up and running you can access the application at + +``` +http://localhost:9000/api-hub +``` + +## Unit tests +``` +sbt test +``` + +## Integration tests +``` +sbt it:test +``` + +## License + +This code is open source software licensed under the [Apache 2.0 License]("http://www.apache.org/licenses/LICENSE-2.0.html"). diff --git a/build.sbt b/build.sbt index 751a4d40..dd8738f7 100644 --- a/build.sbt +++ b/build.sbt @@ -13,7 +13,7 @@ lazy val root = (project in file(".")) .configs(IntegrationTest) .settings(inConfig(IntegrationTest)(itSettings): _*) .settings(majorVersion := 0) - .settings(useSuperShell in ThisBuild := false) + .settings(ThisBuild / useSuperShell := false) .settings( scalaVersion := "2.12.15", name := appName, @@ -48,7 +48,7 @@ lazy val root = (project in file(".")) ), libraryDependencies ++= AppDependencies(), retrieveManaged := true, - evictionWarningOptions in update := + update / evictionWarningOptions := EvictionWarningOptions.default.withWarnScalaVersionEviction(false), resolvers ++= Seq(Resolver.jcenterRepo), // concatenate js @@ -62,9 +62,10 @@ lazy val root = (project in file(".")) uglifyCompressOptions := Seq("unused=false", "dead_code=false"), pipelineStages := Seq(digest), // below line required to force asset pipeline to operate in dev rather than only prod - pipelineStages in Assets := Seq(concat,uglify), + Assets / pipelineStages := Seq(concat,uglify), // only compress files generated by concat - includeFilter in uglify := GlobFilter("application.js") + uglify / includeFilter := GlobFilter("application.js"), + Global / excludeLintKeys += update / evictionWarningOptions ) lazy val testSettings: Seq[Def.Setting[_]] = Seq( diff --git a/conf/application.conf b/conf/application.conf index aea67c32..b32a5e17 100644 --- a/conf/application.conf +++ b/conf/application.conf @@ -29,7 +29,7 @@ play.application.loader = "uk.gov.hmrc.play.bootstrap.ApplicationLoader" play.modules.enabled += "uk.gov.hmrc.play.bootstrap.FrontendModule" play.modules.enabled += "uk.gov.hmrc.play.bootstrap.HttpClientModule" -play.modules.enabled += "uk.gov.hmrc.play.bootstrap.AuditModule" +play.modules.enabled += "uk.gov.hmrc.play.audit.AuditModule" play.modules.enabled += "uk.gov.hmrc.play.bootstrap.AuthModule" play.modules.enabled += "uk.gov.hmrc.play.bootstrap.graphite.GraphiteMetricsModule" play.modules.enabled += "uk.gov.hmrc.mongo.play.PlayMongoModule" diff --git a/project/AppDependencies.scala b/project/AppDependencies.scala index f94184f5..d706c0c2 100644 --- a/project/AppDependencies.scala +++ b/project/AppDependencies.scala @@ -8,7 +8,6 @@ object AppDependencies { "uk.gov.hmrc" %% "play-frontend-hmrc" % "3.22.0-play-28", "uk.gov.hmrc" %% "play-conditional-form-mapping" % "1.11.0-play-28", "uk.gov.hmrc" %% "bootstrap-frontend-play-28" % "6.4.0", - "uk.gov.hmrc" %% "play-language" % "5.3.0-play-28", "uk.gov.hmrc.mongo" %% "hmrc-mongo-play-28" % "0.68.0" ) diff --git a/project/build.properties b/project/build.properties index d4e6820a..5f4606ff 100644 --- a/project/build.properties +++ b/project/build.properties @@ -1,2 +1,2 @@ -sbt.version=1.5.8 +sbt.version=1.6.2 hmrc-frontend-scaffold.version=0.28.0 diff --git a/project/plugins.sbt b/project/plugins.sbt index c273f086..a1587fba 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -4,9 +4,7 @@ resolvers += Resolver.url("HMRC-open-artefacts-ivy", url("https://open.artefacts resolvers += "Typesafe Releases" at "https://repo.typesafe.com/typesafe/releases/" -addSbtPlugin("uk.gov.hmrc" % "sbt-auto-build" % "3.7.0") - -addSbtPlugin("uk.gov.hmrc" % "sbt-git-versioning" % "2.4.0") +addSbtPlugin("uk.gov.hmrc" % "sbt-auto-build" % "3.8.0") addSbtPlugin("uk.gov.hmrc" % "sbt-distributables" % "2.1.0")