@@ -1,75 +1,96 @@
11# Obelisk
22
33[](http://www.haskell.org)
4−[](https://github.com/obsidiansystems/obelisk/blob/master/LICENSE)
4+[](https://tldrlegal.com/license/bsd-3-clause-license-%28revised%29)
55
6−<p align="center"><img src="docs/obelisk-logo-640.png" width="50%" alt="Obelisk Logo"></p>
76
8−Functional reactive web and mobile applications, with batteries included. Obelisk's goal is to represent a cohesive, highly-curated set of choices that [Obsidian Systems](https://obsidian.systems/) has made for building these types of applications in a way that is extremely fast but does not compromise on production readiness.
7+Obelisk provides an easy way to develop and deploy your [Reflex](https://github.com/reflex-frp/reflex) project as web apps and as mobile apps.
98
10−- [Overview](#overview)
11− - [Who should consider using it?](#who-should-consider-using-it)
129- [Installing Obelisk](#installing-obelisk)
1310- [Developing an Obelisk project](#developing-an-obelisk-project)
11+ - [Adding Packages](#adding-packages)
12+ - [Adding Package Overrides](#adding-package-overrides)
13+ - [Running over HTTPS](#running-over-https)
1414 - [IDE Support](#ide-support)
15+ - [Terminal-based feedback](#terminal-based-feedback)
16+ - [Experimental `ghcide` support](#experimental-ghcide-support)
1517- [Deploying](#deploying)
18+ - [Locally](#locally)
1619 - [Default EC2 Deployment](#default-ec2-deployment)
1720 - [Custom Non-EC2 Deployment](#custom-non-ec2-deployment)
1821 - [VirtualBox Deployment](#virtualbox-deployment)
19− - [Locally](#locally)
2022 - [From macOS](#from-macos)
2123 - [Deploying an updated version](#deploying-an-updated-version)
2224- [Mobile](#mobile)
2325 - [iOS](#ios)
2426 - [Android](#android)
25−- [Frequently Asked Questions (FAQ)](#frequently-asked-questions-faq)
26−- [Contributing](#contributing)
27−
28−## Overview
29−
30−Obelisk allows you to build high-quality web and mobile applications very quickly using [Reflex](https://reflex-frp.org/). In minutes you can go from an empty directory to an interactive application that works on web, iOS, and Android, all sharing the same Haskell codebase! Obelisk's development environment also enables extremely rapid development and feedback. You can take advantage of Haskell's type system across the frontend and backend boundary. This means changes to your backend that would break your frontend are immediately detected during development and vice versa. Obelisk uses Haskell's compiler to give you a complete "TODO list" of what needs to be updated.
31−
32−Obelisk is targeted primarily at Haskell developers who want to build high-quality web and/or mobile applications in Haskell, without the distractions of manually choosing and integrating technology for every piece of the system.
33−
34−### Who should consider using it?
35−
36−Obelisk assumes basic knowledge of [Haskell](https://www.haskell.org/) and [Reflex/Reflex-DOM](https://reflex-frp.org/), web technologies like [HTML](https://developer.mozilla.org/en-US/docs/Web/HTML) and [CSS](https://developer.mozilla.org/en-US/docs/Web/CSS), and a terminal shell like [Bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)). Knowledge of [Nix](https://nixos.org/) helps but is not strictly necessary.
37−
3827
3928## Installing Obelisk
40−
41291. [Install Nix](https://nixos.org/nix/).
4230 If you already have Nix installed, make sure you have version 2.0 or higher. To check your current version, run `nix-env --version`.
43311. Set up nix caches
4432 1. If you are running NixOS, add this to `/etc/nixos/configuration.nix`:
45− ```nix
33+ ```
4634 nix.binaryCaches = [ "https://nixcache.reflex-frp.org" ];
4735 nix.binaryCachePublicKeys = [ "ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=" ];
4836 ```
4937 and rebuild your NixOS configuration (e.g. `sudo nixos-rebuild switch`).
50− 1. If you are using another operating system or Linux distribution, ensure that these lines are present in your Nix configuration file (`/etc/nix/nix.conf` on most systems; [see full list](https://nixos.org/nix/manual/#sec-conf-file)):
51− ```nix
52− binary-caches = https://cache.nixos.org https://nixcache.reflex-frp.org
53− binary-cache-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
54− binary-caches-parallel-connections = 40
38+ 1. If you are using another operating system or linux distribution, ensure that these lines are present in your Nix configuration file (`/etc/nix/nix.conf` on most systems; [see full list](https://nixos.org/nix/manual/#sec-conf-file)):
39+ ```
40+ binary-caches = https://cache.nixos.org https://nixcache.reflex-frp.org
41+ binary-cache-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ryantrinkle.com-1:JJiAKaRv9mWgpVAz8dwewnZe0AzzEAzPkagE9SP5NWI=
42+ binary-caches-parallel-connections = 40
5543 ```
56− * If you're on a Linux distribution other than NixOS, enable sandboxing (see these [issue 172](https://github.com/obsidiansystems/obelisk/issues/172#issuecomment-411507818) or [issue 6](https://github.com/obsidiansystems/obelisk/issues/6) if you run into build problems) by adding the following:
57− ```nix
44+ * other Linux: enable sandboxing (see these [issue172](https://github.com/obsidiansystems/obelisk/issues/172#issuecomment-411507818) or [issue6](https://github.com/obsidiansystems/obelisk/issues/6) if you run into build problems)
45+ ```
5846 sandbox = true
5947 ```
60− * If you're on MacOS, disable sandboxing (there are still some impure dependencies for now) by adding the following:
61− ```nix
48+ * MacOS: disable sandboxing (there are still some impure dependencies for now)
49+ ```
6250 sandbox = false
6351 ```
6452 then restart the nix daemon
65− ```bash
53+ ```
6654 sudo launchctl stop org.nixos.nix-daemon
6755 sudo launchctl start org.nixos.nix-daemon
6856 ```
69−1. Install obelisk:
70− ```bash
71− nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command
72− ```
57+1. Install obelisk: `nix-env -f https://github.com/obsidiansystems/obelisk/archive/master.tar.gz -iA command`
58+
59+### Contributing to Obelisk
60+
61+When developing on obelisk itself you may launch `ghcid` for the corresponding project as follows. For example to launch ghcid for `lib/backend` project:
62+
63+```bash
64+nix-shell -A obeliskEnvs.obelisk-backend --run "cd lib/backend && ghcid -c 'cabal new-repl'"
65+```
66+
67+Or to launch ghcid for `lib/command` project:
68+
69+```bash
70+nix-shell -A obeliskEnvs.obelisk-command --run "cd lib/command && ghcid -c 'cabal new-repl'"
71+```
72+
73+To re-install `ob` from source do
74+```bash
75+nix-env -f /path/to/obelisk -iA command
76+```
77+
78+Note that `ob` will defer to the version found in your project's `.obelisk/impl` directory. To update that version specifically:
79+
80+```bash
81+ob thunk unpack ./.obelisk/impl
82+cd ./.obelisk/impl
83+# apply your changes
84+```
85+
86+If you want to commit your changes, first push them to your fork of obelisk and then
87+
88+```bash
89+cd /your/project/root
90+ob thunk pack .obelisk/impl
91+git add .obelisk/impl
92+git commit -m "Bump obelisk"
93+```
7394
7495### Accessing private repositories
7596
@@ -99,12 +120,119 @@ Firefox will not be able to properly run the development website due to [issue 4
99120
100121Every time you change the Haskell source files in frontend, common or backend, `ob run` will automatically recompile the modified files and reload the server. Furthermore, it will display on screen compilation errors and warnings if any.
101122
123+### Adding packages
124+
125+In order to add package dependencies, declare them under the build-depends field in the appropriate cabal files (backend, common, and frontend each have their own). The corresponding Nix packages will automatically be selected when building.
126+
127+### Adding package overrides
128+
129+To add a version override to any Haskell package, or to add a Haskell package that doesn't exist in the nixpkgs used by Obelisk, use the `overrides` attribute in your project's `default.nix`. For example, to use a specific version of the `aeson` package fetched from GitHub and a specific version of the `waargonaut` package fetched from Hackage, your `default.nix` will look like:
130+
131+```nix
132+# ...
133+project ./. ({ pkgs, ... }: {
134+# ...
135+ overrides = self: super: let
136+ aesonSrc = pkgs.fetchFromGitHub {
137+ owner = "obsidiansystems";
138+ repo = "aeson-gadt-th";
139+ rev = "ed573c2cccf54d72aa6279026752a3fecf9c1383";
140+ sha256 = "08q6rnz7w9pn76jkrafig6f50yd0f77z48rk2z5iyyl2jbhcbhx3";
141+ };
142+ in
143+ {
144+ aeson = self.callCabal2nix "aeson" aesonSrc {};
145+ waargonaut = self.callHackageDirect {
146+ pkg = "waargonaut";
147+ ver = "0.8.0.1";
148+ sha256 = "1zv28np3k3hg378vqm89v802xr0g8cwk7gy3mr77xrzy5jbgpa39";
149+ } {};
150+ };
151+# ...
152+```
153+
154+For further information see [the Haskell section](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure) of nixpkgs Contributors Guide.
155+
156+### Adding extra local packages
157+
158+If the standard packages (`frontend`, `backend`, and `common`) are not
159+enough, to add more local Haskell packages, define them with the
160+`packages` parameter. The sources of these packages will be
161+automatically reloaded by `ob run`.
162+
163+```nix
164+# ...
165+project ./. ({ pkgs, ... }: {
166+# ...
167+ packages = {
168+ another = ./another;
169+ };
170+# ...
171+```
172+
173+### Running over HTTPS
174+
175+To run your app locally over HTTPS, update the protocol in `config/common/route` to `https`, and then use `ob run` as normal.
176+
177+Since Obelisk generates a self-signed certificate for running HTTPS, the browser will issue a warning about using an invalid certificate. On Chrome, you can go to `chrome://flags/#allow-insecure-localhost` to enable invalid certificates for localhost.
178+
102179### IDE Support
103180
181+#### Terminal-based feedback
182+
104183Obelisk officially supports terminal-based feedback (akin to [`ghcid`](https://github.com/ndmitchell/ghcid)) in `ob run` and `ob watch`.
105184
185+#### **Experimental** `ghcide` support
186+
187+> **NOTE:** `ghcide` support is strictly **experimental** and **not officially supported**. There is no guarantee that it will work for you or that this support will be maintained over time.
188+
189+To try out the **experimental** [`ghcide`](https://github.com/digital-asset/ghcide) support:
190+
191+ * Install a `ghcide` plugin for your editor.
192+ * Add `__withGhcide = true;` to your Obelisk project's `default.nix` (inside the call to `project`). With this setting, `ob shell` will provide `ghcide` as well.
193+ * Add `hie-bios.sh` to the root of your project:
194+ ```shell
195+ cat > hie-bios.sh <<'EOF'
196+ #!/usr/bin/env bash
197+ source "$HOME/.bash_profile"; # NOTE: Some editors need help finding 'ob' and this assumes that `ob` is made available on your `$PATH` in `.bash_profile`
198+ ob internal export-ghci-configuration > "$HIE_BIOS_OUTPUT"
199+ EOF
200+ chmod +x hie-bios.sh
201+ ```
202+ * **Note:** In some projects you need to use `ob internal export-ghci-configuration --use-relative-paths` in this script instead. This is known to happen when your project contains symlinks to other packages.
203+ * Add `hie.yaml` to the root of your project:
204+ ```shell
205+ echo 'cradle: { bios: { program: hie-bios.sh } }' > hie.yaml
206+ ```
207+ * Test the configuration with `ob shell ghcide`. Assuming your project compiles and works with `ghcide` otherwise, this should succeed.
208+ * Start your editor in a way that it can access the appropriate `ghcide`:
209+ * This can sometimes be achieved with `ob shell 'start my editor'`.
210+ * If you can't easily start your editor in a way that it inherits your shell, you may need to customize how your `ghcide` plugin finds `ghcide` or create a custom `ghcide` replacement script that you install globally. For example, for Visual Studio Code on macOS adding a script called `ghcide` to your `PATH` like the one below will cause `ghcide` from each project's `ob shell` to be used:
211+ ```shell
212+ #!/usr/bin/env bash
213+ source "$HOME/.bash_profile" # NOTE: This assumes that `ob` is made available on your `$PATH` in `.bash_profile`
214+ ob shell "ghcide $@"
215+ ```
216+
106217## Deploying
107218
219+### Locally
220+
221+Build everything:
222+
223+```bash
224+nix-build -A exe --no-out-link
225+```
226+
227+Copy the result to a new directory, add configuration, and run!
228+
229+```bash
230+mkdir test-app
231+ln -s $(nix-build -A exe --no-out-link)/* test-app/
232+cp -r config test-app
233+(cd test-app && ./backend)
234+```
235+
108236### Default EC2 Deployment
109237
110238In this section we will demonstrate how to deploy your Obelisk app to an Amazon EC2 instance. Obelisk deployments are configured for EC2 by default (see [Custom Non-EC2 Deployment](#custom-non-ec2-deployment)).
@@ -114,14 +242,14 @@ First create a new EC2 instance:
1142421. Launch a NixOS 19.09 EC2 instance (we recommend [this AMI](https://console.aws.amazon.com/ec2/v2/home?region=us-east-1#LaunchInstanceWizard:ami=ami-00a8eeaf232a74f84))
1152431. In the instance configuration wizard ensure that your instance has at least 1GB RAM and 10GB disk space.
1162441. When prompted save your AWS private key (`~/myaws.pem`) somewhere safe. We'll need it later during deployment.
117−1. Go to "Security Groups", select your instance's security group and under "Inbound" tab add a new rule for HTTP port 80 and HTTPS port 443.
245+1. Go to "Security Groups", select your instance's security group and under "Inbound" tab add a new rule for HTTP port 80 and 443.
118246
119247At this stage your instance should be booting and become accessible shortly. Note down the hostname of your EC2 instance.
120248
121249Now go to your Obelisk project directory (`~/code/myapp`), and initialize a deployment config (`~/code/myapp-deploy`):
122250Your project directory must be "thunkable", i.e. something on which `ob thunk pack` can be called. Usually it will be a git repository whose current revision has been pushed upstream.
123251
124−```bash
252+```
125253cd ~/code/myapp
126254SERVER=ec2-35-183-22-197.ca-central-1.compute.amazonaws.com
127255ROUTE=https://myapp.com # Publicly accessible route to your app
@@ -140,7 +268,7 @@ This step will also require that you manually verify the authenticity of the hos
140268
141269Next, go to the deployment directory that you just initialized and deploy!
142270
143−```bash
271+```
144272cd ~/code/myapp-deploy
145273ob deploy push
146274```
@@ -169,25 +297,6 @@ Here's a `module.nix` that is configured for deployment to a VirtualBox VM (runn
169297
170298The `{...}:` and following is the [NixOS module](https://nixos.org/nixos/manual/index.html#sec-writing-modules) definition.
171299
172−### Locally
173−
174−If you want deploy your application locally or test a production-oriented build you can build and deploy the app as described below.
175−
176−Build the application:
177−
178−```bash
179−nix-build -A exe --no-out-link
180−```
181−
182−Copy the result to a new directory, add configuration, and run!
183−
184−```bash
185−mkdir test-app
186−ln -s $(nix-build -A exe --no-out-link)/* test-app/
187−cp -r config test-app
188−(cd test-app && ./backend)
189−```
190−
191300### From macOS
192301
193302Deploying from macOS requires some extra setup:
@@ -221,7 +330,7 @@ Your account must also belong to an Apple Developer Team, if you want to access
2213301. Click accept to authorize on both the computer and the iPhone.
222331
223332##### Xcode
224−Install Xcode 11.2 (contains iOS SDK 13.2) and open it so that it runs its post install tool setup.
333+Install Xcode 8.2 (contains iOS SDK 10.2) and open it so that it runs its post install tool setup.
225334
226335These versions will work out of the box but iOS SDKs prior to 11.3 should also work. You can choose another installed version in `default.nix`
227336
@@ -314,13 +423,3 @@ This should copy over and install the application on your device (if you see a
314423##### Build a release version
315424
316425After having configured signing for your app, you may proceed to build a release version of the app. This is no different to how you build the non-release version, so consult the section [Android](#android) further above for exact instructions on building and deploying to your device.
317−
318−
319−## Frequently Asked Questions (FAQ)
320−
321−Refer to [FAQ](FAQ.md).
322−
323−
324−## Contributing
325−
326−Contributions and issue reports are encouraged and appreciated! Refer to the [Contributing](CONTRIBUTING.md) guide for information about getting started.