Skip to content

improve docs #298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 2, 2025
Merged

improve docs #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eb34b5c
update deployment instructions
nikgraf Jul 2, 2025
ece6342
add typesync development instructions
nikgraf Jul 2, 2025
bf25f39
fix type and link in docs
nikgraf Jul 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,6 @@ pnpm dev
# in another tab
cd apps/server
pnpm dev
# in another tab
cd apps/typesync
pnpm build
# then, from anywhere in the repo, start Typesync
hypergraph typesync
```

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

You can run the Typesync Next example app with:
To develop the Typesync CLI, you can run:

```sh
cd apps/typesync
pnpm dev
```

To develop the Typesync frontend run:

```sh
# open the vite.config.ts and comment out the server object that specifies the port to be 3000
cd apps/typesync
pnpm run dev:cli
# in another tab
cd apps/typesync
pnpm dev:client
```

You can run the Next example app with:

```sh
# Notes:
Expand Down Expand Up @@ -86,6 +99,10 @@ fly volumes create data -s 1 -r fra

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

# deploy (ha=false to avoid starting multiple instances)
fly launch --ha=false
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/query-public-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Query Private Data
# Query Public Data

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).
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).

## useQuery

Expand Down
Loading