temp

qualify-web-ui/README.md

@@ -0,0 +1,57 @@
+## Sample Miso-JSaddle application
+
+
+It's possible to build miso applications with `ghcid`, `miso` and `jsaddle`. This can enable a faster workflow due to hot reloading of the code.
+
+This application (sample-app-jsaddle) serves as an example of development w/ GHC, and releases with GHCJS.
+
+To take advantage of the hot reload code features, we recommend running the following command (see below) in a shell. (This will invoke `ghcid` for you).
+
+## Dev
+```bash
+nix-shell --run reload
+```
+
+You should now be able to open your browser to `http://localhost:8080` and see your working application. Subsequent edits of the code should cause a live update of the website at that address.
+
+To build the application w/ GHCJS, execute the below command.
+
+## Build w/ GHCJS
+```bash
+nix-build -A release
+```
+
+## Dev with `stack`
+
+In order to build `miso` w/ `jsaddle` support, it is necessary to remove the existing `miso` package first.
+
+```bash
+stack exec -- ghc-pkg unregister --force miso
+```
+
+Enable the `jsaddle` flag by adding the following to your project's `package.yaml` file, then call `stack build`.
+
+```yaml
+flags:
+  miso:
+    jsaddle: true
+```
+
+## Add external javascript file
+
+First download the external javascript file (`your-file.js`) to your project directory.
+Then add `bytestring` to `build-depends` in `app.cabal`.
+In your `Main.hs`  you need to change the implementation of `runApp` from this:
+```
+runApp f =
+  Warp.runSettings (Warp.setPort 8080 (Warp.setTimeout 3600 Warp.defaultSettings)) =<<
+    JSaddle.jsaddleOr defaultConnectionOptions (f >> syncPoint) JSaddle.jsaddleApp
+```
+to this:
+```
+runApp f = do
+  bString <- B.readFile "your-file.js"
+  jSaddle <- JSaddle.jsaddleOr defaultConnectionOptions (f >> syncPoint) (JSaddle.jsaddleAppWithJs (B.append (JSaddle.jsaddleJs False) bString))
+  Warp.runSettings (Warp.setPort 8081 (Warp.setTimeout 3600 Warp.defaultSettings)) jSaddle
+```
+Now you should be able to use `your-file.js` in jsaddle.