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
35 changes: 3 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,26 +24,20 @@ cd apps/server
pnpm dev
# in another tab
cd apps/typesync
pnpm run dev:client
```

You can also run Typesync after building:

```sh
# Build all packages and apps first
pnpm build
# Then start Typesync
# 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:

```sh
cd apps/server
pnpm prisma migrate dev # this will also generate the Prisma client
```

You can run the next example app with:
You can run the Typesync Next example app with:

```sh
# Notes:
Expand All @@ -52,29 +46,6 @@ cd apps/next-example
pnpm dev
```

### Scaffolding a new Hypergraph application

```sh
# 1. Launch TypeSync (if it isn't already running)
hypergraph typesync

# 2. In the browser UI click **Generate App**, choose an app name (e.g. `my-app`).
# When the toast says "Application my-app generated at ./my-app" the scaffold
# is complete and all dependencies are already installed.

# 3. Run the app
cd my-app
pnpm dev
```

That's it – the generator automatically

* adds the app to `pnpm-workspace.yaml`,
* runs `pnpm install` inside the new folder, *and*
* re-installs at the workspace root so everything stays in sync.

You can immediately start hacking in [`src/routes`](my-app/src/routes) and the
Vite dev server will hot-reload your changes.

## Upgrading Dependencies

Expand Down
31 changes: 23 additions & 8 deletions apps/typesync/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,31 @@ pnpm install -g @graphprotocol/hypergraph-cli

## Running

```bash
hypergraph --help
hg --help # short alias
### Setup

# opening TypeSync
hypergraph typesync
hg typesync
```sh
pnpm install
cd apps/server
cp .env.example .env
# add the PRIVY_APP_SECRET & PRIVY_APP_ID to the apps/server/.env file
pnpm prisma migrate dev
```

# opening TypeSync in firefox automatically
hypergraph typesync --open --browser firefox
### Development

```sh
pnpm build --watch
# in another tab
cd apps/events
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
```

## Commands
Expand Down
26 changes: 26 additions & 0 deletions docs/docs/faucet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Geo Testnet Faucet
description: Request GEO tokens for development and testing on the Geo Testnet.
---

# 🪙 Geo Testnet Faucet

Need some GEO testnet tokens to start building with Hypergraph? Use our public faucet to quickly top-up your wallet.

[**Open the Geo Faucet**](https://faucet.conduit.xyz/geo-test-zc16z3tcvf)

## How it works

1. Switch your wallet/network to **Geo Testnet**.
2. Navigate to the faucet URL above and connect your wallet.
3. Click **Request tokens**. You should receive GEO in a few seconds.

That's it! You can now use the test tokens with any Hypergraph-powered app running on the Geo Testnet.

> Tip: If you run out of test tokens, come back to the faucet and request again (rate-limited to prevent abuse).

---

### Edit on GitHub :bust_in_silhouette:

[✏️ Improve this page](https://github.com/graphprotocol/hypergraph/edit/main/docs/docs/faucet.md)
1 change: 1 addition & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ const sidebars = {
// By default, Docusaurus generates a sidebar from the docs folder structure
docs: [
{ type: 'doc', id: 'quickstart', label: '🚀 Quickstart' },
{ type: 'doc', id: 'faucet', label: '🪙 Testnet Faucet' },
{ type: 'doc', id: 'key-features', label: '🌟 Key Features' },
{ type: 'doc', id: 'core-concepts', label: '🧠 Core Concepts' },
{ type: 'doc', id: 'api-reference', label: '📚 API Reference' },
Expand Down
Loading