Skip to content

Commit 1cbcb80

Browse files
authored
improve docs (#298)
1 parent c47bdbb commit 1cbcb80

File tree

2 files changed

+25
-8
lines changed

2 files changed

+25
-8
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,6 @@ pnpm dev
2626
# in another tab
2727
cd apps/server
2828
pnpm dev
29-
# in another tab
30-
cd apps/typesync
31-
pnpm build
32-
# then, from anywhere in the repo, start Typesync
33-
hypergraph typesync
3429
```
3530

3631
Any time you make changes to the schema, you will need to run the following commands:
@@ -40,7 +35,25 @@ cd apps/server
4035
pnpm prisma migrate dev # this will also generate the Prisma client
4136
```
4237

43-
You can run the Typesync Next example app with:
38+
To develop the Typesync CLI, you can run:
39+
40+
```sh
41+
cd apps/typesync
42+
pnpm dev
43+
```
44+
45+
To develop the Typesync frontend run:
46+
47+
```sh
48+
# open the vite.config.ts and comment out the server object that specifies the port to be 3000
49+
cd apps/typesync
50+
pnpm run dev:cli
51+
# in another tab
52+
cd apps/typesync
53+
pnpm dev:client
54+
```
55+
56+
You can run the Next example app with:
4457

4558
```sh
4659
# Notes:
@@ -86,6 +99,10 @@ fly volumes create data -s 1 -r fra
8699

87100
# set the DATABASE_URL (not sure if it's necessary since already set in the Dockerfile)
88101
fly secrets set DATABASE_URL=file:/data/production.sqlite
102+
# set the Privy app secret, id and chain (fill in your values)
103+
fly secrets set PRIVY_APP_SECRET=<PRIVY_APP_SECRET>
104+
fly secrets set PRIVY_APP_ID=<PRIVY_APP_ID>
105+
fly secrets set HYPERGRAPH_CHAIN=<HYPERGRAPH_CHAIN>
89106

90107
# deploy (ha=false to avoid starting multiple instances)
91108
fly launch --ha=false

docs/docs/query-public-data.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Query Private Data
1+
# Query Public Data
22

3-
Based on your schema, you can query public data that your created using Hypergraph. It works very much like [querying private data](#query-private-data).
3+
Based on your schema, you can query public data that your created using Hypergraph. It works very much like [querying private data](/docs/query-private-data).
44

55
## useQuery
66

0 commit comments

Comments
 (0)