Stout

GraphQL API for pubcrawler.

Installation

To run Stout, you need sbt.

For OSX, run:

$ brew install sbt

For Windows, read the instructions on http://www.scala-sbt.org/0.13/docs/Installing-sbt-on-Windows.html.

Database setup

Stout requires a running PostgreSQL database. By default, Stout assumes that the server runs on localhost:5432, with a database named stout, a user stout, and a password stout password. These connection parameters are set in application.conf, and can be overridden by setting the following environment variable:

• DATABASE_JDBC_URL

To set up a PostgreSQL server with the default settings, run the bin/start-postgres.sh script.

Database migrations

To migrate the database, run the following command

$ ./sbt flywayMigrate

To clean old contents of the database, run:

$ ./sbt flywayClean

Build & Run

$ ./sbt
> jetty:start

For live reloading, subtsitute jetty:start with ~;jetty:stop;jetty:start.

GraphQL API is then available on http://localhost:8080/.

API documentation

We have generated swagger documentation for our API. The swagger documentation is availble at http://localhost:8080/docs. Swagger-ui enables you to view the documentation as well as live testing. Head over to https://github.com/swagger-api/swagger-ui/.

It is to be noted that since we currently support v1.2 of the swagger specification, only swagger-ui of version v2.x is supported.

Testing

$ ./sbt test

Debugging in IntelliJ IDEA

Start SBT and the container as usual (./sbt then jetty:start).

After that, go to Run-> Edit configurations in IntelliJ. Click the + button, select Remote to make a new remote debugging configuration, and call it Scalatra Debug. In IntelliJ 15, the default run conf should work (it looks like this):

-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=5005

Now just select Run -> Debug 'Scalatra Debug'. Setting breakpoints and stepping through code should work.

Building for deployment

You can build a standalone jetty servlet for deployment by using sbt-assembly plugin like this:

$ sbt assembly

You can then run the server using:

$ java -jar target/scala-2.12/Stout-assembly-0.0.1-SNAPSHOT.jar