Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 0 additions & 11 deletions .changeset/solid-shirts-mate.md

This file was deleted.

11 changes: 11 additions & 0 deletions apps/create-hypergraph/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# create-hypergraph

## 0.5.0
### Minor Changes

- df9e7eb: Add typesync script to templates. Bump both template @graphprotocol/hypergraph and @graphprotocol/hypergraph-react packages to 0.6.0 with typesync

Running typesync:

1. scaffold a hypergraph app: `pnpm create hypergraph@latest --template vite-react --package-manager pnpm my-hypergraph-app`
2. approve builds: `pnpm approve-builds`
3. run typesync: `pnpm run typesync`

## 0.4.6
### Patch Changes

Expand Down
45 changes: 44 additions & 1 deletion apps/create-hypergraph/llms.txt
Original file line number Diff line number Diff line change
Expand Up @@ -136,4 +136,47 @@ After successful scaffolding, navigate to your app directory and start developme
```bash
cd <app-name>
pnpm run dev # or npm/yarn/bun run dev
```
```

## TypeSync Studio

Hypergraph includes TypeSync Studio, a visual tool for managing your application's data schema. After scaffolding your app, you can use it to:

- Design and edit your GRC-20 compliant data schema
- Generate TypeScript types from your schema
- Manage entity relationships
- Export schema definitions

To open TypeSync Studio, run:
```bash
pnpm run typesync
```

This will:
1. Start a local server on port 3000
2. Open TypeSync Studio in your default browser
3. Watch your local schema files for changes
4. Allow you to visually edit and sync your schema

### Alternative Commands

The scaffolded templates include a convenient npm script, so you can also run TypeSync directly using:
```bash
pnpm hypergraph typesync
# or
pnpm hg typesync
```

### TypeSync CLI Options

When using the direct CLI command, you can specify options:
- `--open` (default: true): Automatically open the studio in your browser
- `--browser, -b`: Specify which browser to use
- Options: `chrome`, `firefox`, `edge`, `safari`, `arc`, `browser` (default), `browserPrivate`

Example:
```bash
pnpm hypergraph typesync --browser chrome
```

The TypeSync Studio provides a graphical interface for working with your Hypergraph schema, making it easier to design complex data models without manually editing JSON files.
2 changes: 1 addition & 1 deletion apps/create-hypergraph/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "create-hypergraph",
"version": "0.4.6",
"version": "0.5.0",
"description": "CLI toolchain to scaffold a Hypergraph-enabled application with a given template.",
"type": "module",
"bin": {
Expand Down
Loading