https://github.com/keynmol/jobby
Smithy4s (Scala + Scala.js) full-stack application
https://github.com/keynmol/jobby
full-stack scala scalajs smithy smithy4s webapp
Last synced: 8 months ago
JSON representation
Smithy4s (Scala + Scala.js) full-stack application
- Host: GitHub
- URL: https://github.com/keynmol/jobby
- Owner: keynmol
- Created: 2022-07-24T17:27:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-05T16:02:03.000Z (11 months ago)
- Last Synced: 2025-03-30T18:04:44.112Z (9 months ago)
- Topics: full-stack, scala, scalajs, smithy, smithy4s, webapp
- Language: Scala
- Homepage: https://blog.indoorvivants.com/tags/series:smithy4s
- Size: 263 KB
- Stars: 42
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Jobby
This is a full-stack Scala application (job posting board), made with the following excellent libraries and technologies:
1. [Scala 3](https://docs.scala-lang.org/scala3/new-in-scala3.html)
2. [Smithy4s](https://disneystreaming.github.io/smithy4s/) and [Smithy](https://awslabs.github.io/smithy/2.0/index.html#) for the API and protocol
definition between backend and frontend (and in tests)
3. [Scala.js](https://www.scala-js.org) and [Laminar](https://laminar.dev) for the [SPA](https://en.wikipedia.org/wiki/Single-page_application) frontend
4. [PostgreSQL](https://www.postgresql.org) and [Skunk](https://tpolecat.github.io/skunk/) for database access
5. [Weaver-Test](https://disneystreaming.github.io/weaver-test/) for unit and integration testing
The app used to be deployed on
1. Platform.sh but I've run out of the free trial plan
2. 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**](https://jobby-web.fly.dev/)
It's a companion repo for my [4-part blog post series](https://blog.indoorvivants.com/2022-06-10-smithy4s-fullstack-part-1).
### Prerequisites
- 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 .
### Running
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.
### Configuration
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:
```properties
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 to `true` will **disable** hardened cookies for authentication, making
it easier to develop locally
* `RELEASE` - setting it to `yesh` will produce fully optimised, single-file frontend from Scala.js
### Developing
This gets finicky as we try to satisfy the following requirements:
1. Backend should be rebuilt and restarted independently of the frontend
2. Frontend should be rebuilt on a per-module basis, and managed by https://vitejs.dev/
3. 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**