aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jakob@odersky.com>2016-11-14 14:32:13 -0800
committerJakob Odersky <jakob@odersky.com>2016-11-14 14:32:13 -0800
commit9fce0a2be362a2cbd5d78b1ab5b0c13d6f47e89a (patch)
tree8e89229cbb4cbcdcf64a265635dfb34631c227ad /README.md
parent1a0b4bd23ac1b49ddb2f2bbbaf0dde1f9156be18 (diff)
downloadplay-scalajs-chat-9fce0a2be362a2cbd5d78b1ab5b0c13d6f47e89a.tar.gz
play-scalajs-chat-9fce0a2be362a2cbd5d78b1ab5b0c13d6f47e89a.tar.bz2
play-scalajs-chat-9fce0a2be362a2cbd5d78b1ab5b0c13d6f47e89a.zip
More docs and styleHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..09493f6
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+A simple chat application that demonstrates integration of Play with ScalaJS.
+
+## Run
+
+1. start sbt: `sbt`
+2. compile on demand, when files change: `run`
+3. go to `http://localhost:9000/chat/USERNAME` where `USERNAME` is your name of choice
+
+## Important directories
+
+- `server/` contains the Play server that will serve the client app
+- `client/` ScalaJS client app sources
+- `shared/` common sources, available in both server and client. In this project, shared contains messages that are passed between the server and client via a websocket
+
+## References
+- [Play framework](https://www.playframework.com)
+- [ScalaJS](https://www.scala-js.org/)
+- [Play-ScalaJS integration](https://github.com/vmunier/play-with-scalajs-example)