https://github.com/ptrdom/akka-grpc-slinky-grpcweb

Template project for full-stack Scala web development based on gRPC-web.
https://github.com/ptrdom/akka-grpc-slinky-grpcweb

akka-grpc grpc grpc-web scala scalajs slinky

Last synced: 16 days ago
JSON representation

Template project for full-stack Scala web development based on gRPC-web.

• Host: GitHub
• URL: https://github.com/ptrdom/akka-grpc-slinky-grpcweb
• Owner: ptrdom
• License: mit
• Created: 2021-01-10T13:20:23.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-12-23T15:25:35.000Z (about 3 years ago)
• Last Synced: 2024-10-06T03:04:33.696Z (3 months ago)
• Topics: akka-grpc, grpc, grpc-web, scala, scalajs, slinky
• Language: Scala
• Homepage:
• Size: 48.8 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Akka gRPC Slinky gRPC-web

This template project was the result of investigation into full-stack `Scala` web development experience with following requirements:

- Compile time type safety

- Streaming API

- Quick hot reload in development

- Single deployment in production

Decision to base the implementation on `gRPC-Web` came after testing out popular 

implementations of `REST`([autowire](https://github.com/lihaoyi/autowire), 

[endpoints4s](https://github.com/endpoints4s/endpoints4s)) and `GraphQL` 

([sangria](https://github.com/sangria-graphql/sangria), 

[caliban](https://github.com/ghostdogpr/caliban)) 

and realisation that none of existing solutions satisfy each requirement, 

while `gRPC`'s basic functionality has all the required features.   

## How to run

### Development mode

Using `sbt`:

- `startServerDev`

- `startClientDev`

Using `IntelliJ` (tested with `2021.3`):

- Use `server dev start` and `client dev start` Run/Debug configurations provided in `/.run`.

`startServerDev` starts back-end based on Akka HTTP in `watch` mode. 

It serves `gRPC` endpoints for front-end to consume on `localhost:9000`.

`startClientDev` starts `webpack dev server` with `HMR` enabled for front-end development with 

`Scala.js` and `Slinky`. Opening `localhost:8080` in the browser will serve `index.html`.

IntelliJ's `sbt shell` must be enabled to make sbt plugins run during compile - 

integrated Scala compile server won't trigger them.

### Production mode

Using `sbt`:

- `serverProd/run`

Using `IntelliJ` (tested with `2021.3`):

- Use `server prod run` Run/Debug configuration provided in `/.run`.

In production mode, optimized front-end bundle and all assets are packaged together with the back-end, 

then served with aggressive caching enabled by fingerprinting. Server serves both `HTTP` and `gRPC` 

endpoints.

Docker image publishing is implemented with [sbt-native-packager](https://github.com/sbt/sbt-native-packager).

## Slinky IntelliJ support

https://slinky.dev/docs/installation/ section `IntelliJ Support` describes how to add support for `@react` macro.

## Built on:

- [akka-grpc](https://github.com/akka/akka-grpc)

- [scalapb-grpcweb](https://github.com/scalapb/scalapb-grpcweb)

- [sbt-web](https://github.com/sbt/sbt-web)

- [sbt-web-scalajs](https://github.com/vmunier/sbt-web-scalajs)

- [scalajs-bundler](https://github.com/scalacenter/scalajs-bundler)

- [slinky](https://github.com/shadaj/slinky)