763d727 · sphinx · git.iko.soy

README.md+5−5

compare with master

unifiedsplit

@@ -1,4 +1,4 @@

1−# seek

1+# sphinx

2

3## Desk

4

@@ -8,11 +8,11 @@ TODO: Add further documentation on beginning Hoon development

8

9## UI

10

11−seek is built primarily using [React], [Typescript], and [Tailwind CSS]. [Vite] ensures that all code and assets are loaded appropriately, bundles the application for distribution and provides a functional dev environment.

11+sphinx is built primarily using [React], [Typescript], and [Tailwind CSS]. [Vite] ensures that all code and assets are loaded appropriately, bundles the application for distribution and provides a functional dev environment.

12

13### Getting Started

14

15−To get started using seek first you need to run `npm install` inside the `ui` directory.

15+To get started using sphinx first you need to run `npm install` inside the `ui` directory.

16

17To develop you'll need a running ship to point to. To do so you first need to add a `.env.local` file to the `ui` directory. This file will not be committed. Adding `VITE_SHIP_URL={URL}` where **{URL}** is the URL of the ship you would like to point to, will allow you to run `npm run dev`. This will proxy all requests to the ship except for those powering the interface, allowing you to see live data.

18

@@ -25,10 +25,10 @@ To deploy, run `npm run build` in the `ui` directory which will bundle all the c

251. Create or launch an urbit using the -F flag

262. On that urbit, if you don't already have a desk to run from, run `|merge %work our %base` to create a new desk and mount it with `|mount %work`.

273. Now the `%work` desk is accessible through the host OS's filesystem as a directory of that urbit's pier ie `~/zod/work`.

28−4. From the `ui` directory you can run `rsync -avL --delete dist/ ~/zod/work/seek` where `~/zod` is your fake urbit's pier.

28+4. From the `ui` directory you can run `rsync -avL --delete dist/ ~/zod/work/sphinx` where `~/zod` is your fake urbit's pier.

295. Once completed you can then run `|commit %work` on your urbit and you should see your files logged back out from the dojo.

306. Now run `=dir /=garden` to switch to the garden desk directory

31−7. You can now run `-make-glob %work /seek` which will take the folder where you just added files and create a glob which can be thought of as a sort of bundle. It will be output to `~/zod/.urb/put`.

31+7. You can now run `-make-glob %work /sphinx` which will take the folder where you just added files and create a glob which can be thought of as a sort of bundle. It will be output to `~/zod/.urb/put`.

328. If you navigate to `~/zod/.urb/put` you should see a file that looks like this `glob-0v5.fdf99.nph65.qecq3.ncpjn.q13mb.glob`. The characters between `glob-` and `.glob` are a hash of the glob's contents.

339. Now that we have the glob it can be uploaded to any publicly available HTTP endpoint that can serve files. This allows the glob to distributed over HTTP.

3410. Once you've uploaded the glob, you should then update the corresponding entry in the docket file at `desk/desk.docket-0`. Both the full URL and the hash should be updated to match the glob we just created, on the line that looks like this:

desk/app/seek.hoon → desk/app/sphinx.hoonrenamed+2−2

@@ -1,6 +1,6 @@

1−/- s=seek

1+/- s=sphinx

2/+ gossip, default-agent, verb, dbug

3−/+ *seek

3+/+ *sphinx

4/+ sift

5/+ m=metaphone

6/$ grab-listing %noun %directory-listing

desk/desk.bill+1−1

@@ -1,2 +1,2 @@

1−:~ %seek

1+:~ %sphinx

2==

desk/desk.docket-0+2−2

@@ -1,8 +1,8 @@

1−:~ title+'seek'

1+:~ title+'sphinx'

2 info+'An Urbit app that does great things'

3 color+0x2e.4347

4 glob-http+['https://bootstrap.urbit.org/glob-0v5.hurm4.ejod5.ngg9h.iub9i.n1j7o.glob' 0v5.hurm4.ejod5.ngg9h.iub9i.n1j7o]

5− base+'seek'

5+ base+'sphinx'

6 version+[0 0 1]

7 website+'https://github.com'

8 license+'MIT'

desk/gen/publish-all.hoon+2−2

@@ -1,5 +1,5 @@

1−/- s=seek

1+/- s=sphinx

2−/+ *seek

2+/+ *sphinx

3:- %say

4|= $: [now=@da eny=@uv =beak]

5 [ ~]

desk/gen/publish.hoon+2−2

@@ -1,5 +1,5 @@

1−/- s=seek

1+/- s=sphinx

2−/+ *seek

2+/+ *sphinx

3:- %say

4|= $: [now=@da eny=@uv =beak]

5 [[=post:s ~] ~]

desk/lib/seek-json.hoon → desk/lib/sphinx-json.hoonrenamed+1−1

@@ -1,4 +1,4 @@

1−/- s=seek

1+/- s=sphinx

2|%

3++ enjs

4 =, enjs:format

desk/lib/seek.hoon → desk/lib/sphinx.hoonrenamed+1−1

@@ -1,4 +1,4 @@

1−/- *seek

1+/- *sphinx

2|%

3++ iching

4 |= word=@t

desk/mar/declarations.hoon+2−2

@@ -1,5 +1,5 @@

1−/- s=seek

1+/- s=sphinx

2−/+ j=seek-json

2+/+ j=sphinx-json

3|_ d=(list declare:s)

4++ grad %noun

5++ grow

desk/mar/declare.hoon+2−2

@@ -1,5 +1,5 @@

1−/- s=seek

1+/- s=sphinx

2−/+ j=seek-json

2+/+ j=sphinx-json

3|_ =declare:s

4++ grad %noun

5++ grow

desk/mar/directory-listing.hoon+2−2

@@ -1,5 +1,5 @@

1−/- s=seek

1+/- s=sphinx

2−/+ j=seek-json

2+/+ j=sphinx-json

3|_ =listing:s

4++ grad %noun

5++ grow

desk/mar/directory.hoon+2−2

@@ -1,5 +1,5 @@

1−/- s=seek

1+/- s=sphinx

2−/+ j=seek-json

2+/+ j=sphinx-json

3|_ =directory:s

4++ grad %noun

5++ grow

desk/mar/search.hoon+2−2

@@ -1,5 +1,5 @@

1−/- s=seek

1+/- s=sphinx

2−/+ j=seek-json

2+/+ j=sphinx-json

3|_ =search:s

4++ grad %noun

5++ grow

desk/mar/seek-action.hoondeleted

No changes to the content.

desk/sur/seek.hoon → desk/sur/sphinx.hoonrenamed

The content is the same.

desk/ted/publish-all.hoon+2−2

@@ -1,5 +1,5 @@

1/- spider

2−/- s=seek

2+/- s=sphinx

3/+ *strandio

4=, strand=strand:spider

5=/ posts

@@ -36,5 +36,5 @@

36 %+ turn

37 posts

38 |= =declare:s

39− [%pass /poke %agent [our %seek] %poke [%declare !>(declare)]]

39+ [%pass /poke %agent [our %sphinx] %poke [%declare !>(declare)]]

40(pure:m !>(~))

ui/index.html+1−1

@@ -3,7 +3,7 @@

3 <head>

4 <meta charset="UTF-8" />

5 <meta name="viewport" content="width=device-width, initial-scale=1.0" />

6− <title>seek</title>

6+ <title>sphinx</title>

7 <meta name="theme-color" content="#ffffff" />

8 <link rel="icon" href="/src/assets/favicon.svg" sizes="any" type="image/svg+xml" />

9 <link rel="mask-icon" href="/src/assets/safari-pinned-tab.svg" color="#000000" />

ui/package-lock.json+2−2

@@ -1,11 +1,11 @@

1{

2− "name": "seek",

2+ "name": "sphinx",

3 "version": "0.0.0",

4 "lockfileVersion": 2,

5 "requires": true,

6 "packages": {

7 "": {

8− "name": "seek",

8+ "name": "sphinx",

9 "version": "0.0.0",

10 "dependencies": {

11 "@heroicons/react": "^1.0.6",

ui/package.json+1−1

@@ -1,5 +1,5 @@

1{

2− "name": "seek",

2+ "name": "sphinx",

3 "version": "0.0.0",

4 "private": true,

5 "scripts": {

ui/src/app.tsx+1−1

@@ -23,7 +23,7 @@ function Main() {

23export function App() {

24 return (

25 <QueryClientProvider client={queryClient}>

26− <BrowserRouter basename='/apps/seek'>

26+ <BrowserRouter basename='/apps/sphinx'>

27 <Main />

28 </BrowserRouter>

29 </QueryClientProvider>

ui/src/assets/manifest.json+2−2

@@ -1,6 +1,6 @@

1{

2− "name": "seek",

2+ "name": "sphinx",

3− "short_name": "seek",

3+ "short_name": "sphinx",

4 "icons": [

5 {

6 "src": "/apps/grid/android-chrome-512x512.png",

ui/src/components/Filter.tsx+1−1

@@ -1,6 +1,6 @@

1import React from 'react';

2import * as Select from '@radix-ui/react-select';

3−import { PostFilter, PostType } from '../types/seek';

3+import { PostFilter, PostType } from '../types/sphinx';

4

5interface FilterItemProps {

6 title: PostFilter;

ui/src/components/Meta.tsx+1−1

@@ -15,7 +15,7 @@ export const Meta = ({ className }: MetaProps) => {

15 useEffect(() => {

16 if (!version) {

17 api.scry<ChargeUpdateInitial>(scryCharges).then(charges => {

18− const version = charges.initial.seek?.version;

18+ const version = charges.initial.sphinx?.version;

19

20 if (version) {

21 setVersion(version);

ui/src/components/SearchList.tsx+1−1

@@ -1,6 +1,6 @@

1import cn from 'classnames';

2import React from 'react';

3−import { Listing } from '../types/seek';

3+import { Listing } from '../types/sphinx';

4

5interface SearchListProps {

6 listings: Listing[];

ui/src/pages/Post.tsx+2−2

@@ -6,7 +6,7 @@ import { MultiValue } from 'react-select';

6import api from '../api';

7import { Filter } from '../components/Filter';

8import { Option, TagField } from '../components/TagField';

9−import { Declare, Post as PostForm } from '../types/seek';

9+import { Declare, Post as PostForm } from '../types/sphinx';

10

11export const Post = () => {

12 const navigate = useNavigate();

@@ -28,7 +28,7 @@ export const Post = () => {

28

29 const onSubmit = useCallback((values: Omit<PostForm, 'tags'>) => {

30 api.poke<Declare>({

31− app: 'seek',

31+ app: 'sphinx',

32 mark: 'declare',

33 json: {

34 reach: 'friends',

ui/src/pages/Search.tsx+2−2

@@ -4,7 +4,7 @@ import debounce from 'lodash.debounce';

4import { SearchInput } from '../components/SearchInput';

5import { SearchList } from '../components/SearchList';

6import { useQuery } from 'react-query';

7−import { PostFilter, PostType, Search as SearchType } from '../types/seek';

7+import { PostFilter, PostType, Search as SearchType } from '../types/sphinx';

8import api from '../api';

9import { Link, useNavigate, useParams } from 'react-router-dom';

10import { Paginator } from '../components/Paginator';

@@ -40,7 +40,7 @@ export const Search = () => {

40 const pageInt = parseInt(page || '1', 10) - 1;

41 const start = pageInt * size;

42 const { data } = useQuery<unknown, unknown, SearchType>(`lookup-${selected}-${lookup}-${size}-${start}`, () => api.scry<SearchType>({

43− app: 'seek',

43+ app: 'sphinx',

44 path: `/lookup/${selected}/${encodeLookup(lookup)}/${start}/${size}`

45 }), {

46 enabled: !!lookup,

ui/src/types/seek.ts → ui/src/types/sphinx.tsrenamed

The content is the same.

ui/vite.config.ts+1−1

@@ -9,6 +9,6 @@ export default ({ mode }) => {

9 console.log(SHIP_URL);

10

11 return defineConfig({

12− plugins: [urbitPlugin({ base: 'seek', target: SHIP_URL, secure: false }), reactRefresh()]

12+ plugins: [urbitPlugin({ base: 'sphinx', target: SHIP_URL, secure: false }), reactRefresh()]

13 });

14};