Scala + http4s codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to the RealWorld spec and API.

This codebase was created to demonstrate a fully fledged fullstack application built with Scala + http4s including CRUD operations, authentication, routing, pagination, and more.

For more information on how to this works with other frontends/backends, head over to the RealWorld repo.

Getting started

Develop and Compile Dependencies

Ensure the following dependencies are installed and configured:

Java SDK 8 or GraalVM 1.0.x
sbt 1.2.x

Setup Steps

Run sbt test to run the test suite
Run sbt run to run the web application

The app is now accessible from localhost:8080.

Production Packaging (uber-jar)

To package and run it as an uber-jar:

Run sbt assembly to package the application into an uber-jar (realworld-assembly-1.0.0-SNAPSHOT.jar)
Run java -jar target/scala-2.12/realworld-assembly-1.0.0-SNAPSHOT.jar to run the web application

Production Packaging (Graal Native Image)

Ensure Graal is downloaded and its binaries folder added to PATH. To package and run it as a Graal native image:

native-image \
  --no-server \
  --class-path target/scala-2.12/realworld-assembly-1.0.0-SNAPSHOT.jar \
  -H:Class=com.hhandoko.realworld.Main \
  -H:EnableURLProtocols=http,https \
  -H:IncludeResources='logback.xml|application.conf' \
  -H:Name=realworld \
  -H:+AllowVMInspection \
  -H:+ReportUnsupportedElementsAtRuntime

Copy libsunec.so from your JRE lib folder to the realworld binary location
Run ./realworld to run the web application

Alternatively:

Run ./scripts/graal/bin/setup.sh to download and setup Graal.
Run ./scripts/graal/bin/dist.sh to create a native image distribution under the /dist directory.

Progress

Backend API implementation:

Please read PROGRESS for more details.

Issues

Native image generation with jwt-scala (oracle/graal/#1152)
JWT token decoding failed in Graal native image (oracle/graal/#1240)

Contributing

We follow the "feature-branch" Git workflow.

Commit changes to a branch in your fork (use snake_case convention):
- For technical chores, use chore/ prefix followed by the short description, e.g. chore/do_this_chore
- For new features, use feature/ prefix followed by the feature name, e.g. feature/feature_name
- For bug fixes, use bug/ prefix followed by the short description, e.g. bug/fix_this_bug
Rebase or merge from "upstream"
Submit a PR "upstream" to develop branch with your changes

Please read CONTRIBUTING for more details.

License

    Copyright (c) 2019 Herdy Handoko

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

scala-http4s-realworld-example-app is released under the Apache Version 2.0 License. See the LICENSE file for further details.

richard-gibson/scala-http4s-realworld-example-app