This is a full-stack Scala application (job posting board), made with the following excellent libraries and technologies:
- Scala 3
- Smithy4s and Smithy for the API and protocol definition between backend and frontend (and in tests)
- Scala.js and Laminar for the SPA frontend
- PostgreSQL and Skunk for database access
- Weaver-Test for unit and integration testing
The app used to be deployed on
- Platform.sh but I've run out of the free trial plan
- Heroku but they discontinued the free plans for everyone
and now the app is deployed to the lovely Fly.io and here's the live version
It's a companion repo for my 4-part blog post series.
-
JDK 11+
-
SBT installed (or use the
./sbt
launcher provided) -
PostgreSQL Easiest way to run it is:
docker run --name jobby -p 5439:5432 -e POSTGRES_USER=jobby -e POSTGRES_PASSWORD=mysecretpassword -e POSTGRES_DB=jobby -d postgres
Take note of the user, password, database (
jobby
) and host port (5439
), if you wish to reconfigure the connection .
To just run the app (not great for development per se), run the following command:
sbt 'app/run 9999'
Then open http://localhost:9999 - and you should see a (not working) app.
The following settings are respected, and can be either be set as environment variables (recommended for
deployments), or read from the jobby.opts
file at the root of the project, for example:
PG_USER=jobby
PG_PASSWORD=mysecretpassword
PG_DB=jobby
LOCAL_DEPLOYMENT=true
PG_PORT=5439
-
PG_PASSWORD
,PG_HOST
,PG_DB
,PG_USER
,PG_PORT
- variables to configure access to Postgres -
LOCAL_DEPLOYMENT
- setting this totrue
will disable hardened cookies for authentication, making it easier to develop locally -
RELEASE
- setting it toyesh
will produce fully optimised, single-file frontend from Scala.js
This gets finicky as we try to satisfy the following requirements:
- Backend should be rebuilt and restarted independently of the frontend
- Frontend should be rebuilt on a per-module basis, and managed by https://vitejs.dev/
- Request to backend should be proxied
To achieve (1), we need to start the backend without bundling the frontend - removing
the RELEASE
env variable will achieve that:
(in terminal 1)
PG_PASSWORD=mysecretpassword PG_DB=jobby sbt '~app/reStart 9999'
To achieve (2), we need to
a) Continuously rebuilt the frontend:
(in terminal 2)
sbt '~buildFrontend'
b) Run Vite's development server:
(in terminal 3)
cd frontend-build && npm run dev
And (3) is achieved by the configuration in frontend-build/vite.config.js
. Make sure to start
the server on port 9999