Skip to content

Commit 21efecd

Browse files
authored
publish(create-hypergraph): v0.5.0 with added typesync scripts and bumped hypergraph deps (#477)
1 parent df9e7eb commit 21efecd

4 files changed

Lines changed: 56 additions & 13 deletions

File tree

.changeset/solid-shirts-mate.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

apps/create-hypergraph/CHANGELOG.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
# create-hypergraph
22

3+
## 0.5.0
4+
### Minor Changes
5+
6+
- df9e7eb: Add typesync script to templates. Bump both template @graphprotocol/hypergraph and @graphprotocol/hypergraph-react packages to 0.6.0 with typesync
7+
8+
Running typesync:
9+
10+
1. scaffold a hypergraph app: `pnpm create hypergraph@latest --template vite-react --package-manager pnpm my-hypergraph-app`
11+
2. approve builds: `pnpm approve-builds`
12+
3. run typesync: `pnpm run typesync`
13+
314
## 0.4.6
415
### Patch Changes
516

apps/create-hypergraph/llms.txt

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,4 +136,47 @@ After successful scaffolding, navigate to your app directory and start developme
136136
```bash
137137
cd <app-name>
138138
pnpm run dev # or npm/yarn/bun run dev
139-
```
139+
```
140+
141+
## TypeSync Studio
142+
143+
Hypergraph includes TypeSync Studio, a visual tool for managing your application's data schema. After scaffolding your app, you can use it to:
144+
145+
- Design and edit your GRC-20 compliant data schema
146+
- Generate TypeScript types from your schema
147+
- Manage entity relationships
148+
- Export schema definitions
149+
150+
To open TypeSync Studio, run:
151+
```bash
152+
pnpm run typesync
153+
```
154+
155+
This will:
156+
1. Start a local server on port 3000
157+
2. Open TypeSync Studio in your default browser
158+
3. Watch your local schema files for changes
159+
4. Allow you to visually edit and sync your schema
160+
161+
### Alternative Commands
162+
163+
The scaffolded templates include a convenient npm script, so you can also run TypeSync directly using:
164+
```bash
165+
pnpm hypergraph typesync
166+
# or
167+
pnpm hg typesync
168+
```
169+
170+
### TypeSync CLI Options
171+
172+
When using the direct CLI command, you can specify options:
173+
- `--open` (default: true): Automatically open the studio in your browser
174+
- `--browser, -b`: Specify which browser to use
175+
- Options: `chrome`, `firefox`, `edge`, `safari`, `arc`, `browser` (default), `browserPrivate`
176+
177+
Example:
178+
```bash
179+
pnpm hypergraph typesync --browser chrome
180+
```
181+
182+
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.

apps/create-hypergraph/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "create-hypergraph",
3-
"version": "0.4.6",
3+
"version": "0.5.0",
44
"description": "CLI toolchain to scaffold a Hypergraph-enabled application with a given template.",
55
"type": "module",
66
"bin": {

0 commit comments

Comments
 (0)