on master help sign in
seax/INSTRUCTIONS.md
60 lines 1.6 kB history raw
1# Installation Instructions
31. Create a folder and name it whatever you want.
5```bash
6$ mkdir seax-project
7$ cd seax-project
8```
92. Inside the folder, `clone` the **airlock** library and the **seax** project.
11```bash
12$ git clone https://github.com/ilyakooo0/airlock
13$ git clone https://github.com/ilyakooo0/seax
14```
153. Download the v2.11 pill.
17```bash
18$ wget https://bootstrap.urbit.org/urbit-v2.11.pill
19```
204. Start your fake zod using the pill.
22```bash
23$ urbit -B urbit-v2.11.pill -F zod
24```
265. Now, inside dojo run the following:
27```bash
28dojo> |new-desk %seax
29dojo> |mount %seax
30```
326. Back in your shell, run:
33```bash
34$ rm -r zod/seax
35$ cp -r seax/zod/seax zod/seax
36```
387. In the dojo install the seax agent and allow cross-site origin requests from localhost.
39```bash
40dojo> |commit %seax
41dojo> |install our %seax
42dojo> |pass [%e [%approve-origin 'http://localhost:8000']]
43```
458. While your urbit is running in another terminal run:
46```bash
47$ ./seax/dev/elm-live.sh
48```
49The above command will start the frontend which communicates with your zod ship
50using the Elm airlock library.
52Now, you can go to your browser at `http://localhost:8000/`.
53The seax app should be displaying a search bar. You might need to refresh the page once before using the app.
54You'll know that everything works if you see the "< ~zod: Opening airlock!" message in your dojo.
56# Usage Instructions
58Now, you can fill in the search bar with any term you like.
59Clicking "search" will iniate collect any relevant results from the configured search sources.
60In the results page, you can click on any of the sources to filter to only results from that source.