Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hung-phan/scala-template
This is the boilerplate for scala play
https://github.com/hung-phan/scala-template
Last synced: about 10 hours ago
JSON representation
This is the boilerplate for scala play
- Host: GitHub
- URL: https://github.com/hung-phan/scala-template
- Owner: hung-phan
- License: apache-2.0
- Created: 2016-10-23T10:31:59.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T11:49:04.000Z (almost 2 years ago)
- Last Synced: 2024-04-10T20:39:06.508Z (7 months ago)
- Language: Scala
- Size: 669 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Play Framework with Scala.js
[](http://travis-ci.org/hung-phan/scala-template/)
This is a simple example application showing how you can integrate a Play project with a Scala.js project.
The application contains three directories:
* `server` Play application (server side).
* `client` Scala.js application (client side).
* `shared` Scala code that you want to share between the server and the client.
## Run the application
### Requirements
- [node](https://nodejs.org/en/)
Install npm dependencies
```bash
$ cd server/frontend && npm install # run this only once
```
### Development
```bash
$ docker-compose up -d
$ sbt -Dconfig.file=server/conf/development.conf run
$ cd server/frontend && npm run start # in separated terminal
```
### Testing
```bash
$ docker-compose -f docker-compose.test.yml up -d
$ sbt -Dconfig.file=server/conf/testing.conf -Denv=test test
$ docker-compose -f docker-compose.test.yml down
```
### Production
Run this to build all the assets using webpack bundler. You must see the profile to know how to
replace application configuration with your environment configuration.
```bash
$ sbt -Denv=prod webpackProTask
$ sbt -Denv=prod 'set scalaJSStage in Global := FullOptStage' docker:publishLocal # Replace docker:publishLocal with other built tasks on your demand
```
To start it in local, run:
```bash
$ docker-compose -f docker-compose.prod.yml up
```
## Features
The application uses the [sbt-web-scalajs](https://github.com/vmunier/sbt-web-scalajs) sbt plugin and
the [scalajs-scripts](https://github.com/vmunier/scalajs-scripts) library.
- Run your application like a regular Play app
- `compile` triggers the Scala.js fastOptJS command.
- `run` triggers the Scala.js fastOptJS command on page refresh.
- `~compile`, `~run`, continuous compilation is also available.
- Compilation errors from the Scala.js projects are also displayed in the browser.
- Production archives (e.g. using `stage`, `dist`) contain the optimised javascript.
- Source maps
- Open your browser dev tool to set breakpoints or to see the guilty line of code when an exception is thrown.
- Source Maps is _disabled in production_ by default to prevent your users from seeing the source files. But it can
easily be enabled in production too by setting `emitSourceMaps in fullOptJS := true` in the Scala.js projects.
## Cleaning
The root project aggregates all the other projects by default.
Use this root project, called `scala-template`, to clean all the projects at once.
```bash
$ ./scripts/clean.sh
```