Skip to content

Commit 4e2fb0e

Browse files
authored
Improve Readmes + Add Geo Testnet Faucet Documentation (#265)
Docs only changes.
1 parent a31d2ba commit 4e2fb0e

File tree

4 files changed

+53
-40
lines changed

4 files changed

+53
-40
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -24,26 +24,20 @@ cd apps/server
2424
pnpm dev
2525
# in another tab
2626
cd apps/typesync
27-
pnpm run dev:client
28-
```
29-
30-
You can also run Typesync after building:
31-
32-
```sh
33-
# Build all packages and apps first
3427
pnpm build
35-
# Then start Typesync
28+
# then, from anywhere in the repo, start Typesync
3629
hypergraph typesync
3730
```
3831

32+
3933
Any time you make changes to the schema, you will need to run the following commands:
4034

4135
```sh
4236
cd apps/server
4337
pnpm prisma migrate dev # this will also generate the Prisma client
4438
```
4539

46-
You can run the next example app with:
40+
You can run the Typesync Next example app with:
4741

4842
```sh
4943
# Notes:
@@ -52,29 +46,6 @@ cd apps/next-example
5246
pnpm dev
5347
```
5448

55-
### Scaffolding a new Hypergraph application
56-
57-
```sh
58-
# 1. Launch TypeSync (if it isn't already running)
59-
hypergraph typesync
60-
61-
# 2. In the browser UI click **Generate App**, choose an app name (e.g. `my-app`).
62-
# When the toast says "Application my-app generated at ./my-app" the scaffold
63-
# is complete and all dependencies are already installed.
64-
65-
# 3. Run the app
66-
cd my-app
67-
pnpm dev
68-
```
69-
70-
That's it – the generator automatically
71-
72-
* adds the app to `pnpm-workspace.yaml`,
73-
* runs `pnpm install` inside the new folder, *and*
74-
* re-installs at the workspace root so everything stays in sync.
75-
76-
You can immediately start hacking in [`src/routes`](my-app/src/routes) and the
77-
Vite dev server will hot-reload your changes.
7849

7950
## Upgrading Dependencies
8051

β€Žapps/typesync/README.mdβ€Ž

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,31 @@ pnpm install -g @graphprotocol/hypergraph-cli
1717

1818
## Running
1919

20-
```bash
21-
hypergraph --help
22-
hg --help # short alias
20+
### Setup
2321

24-
# opening TypeSync
25-
hypergraph typesync
26-
hg typesync
22+
```sh
23+
pnpm install
24+
cd apps/server
25+
cp .env.example .env
26+
# add the PRIVY_APP_SECRET & PRIVY_APP_ID to the apps/server/.env file
27+
pnpm prisma migrate dev
28+
```
2729

28-
# opening TypeSync in firefox automatically
29-
hypergraph typesync --open --browser firefox
30+
### Development
31+
32+
```sh
33+
pnpm build --watch
34+
# in another tab
35+
cd apps/events
36+
pnpm dev
37+
# in another tab
38+
cd apps/server
39+
pnpm dev
40+
# in another tab
41+
cd apps/typesync
42+
pnpm build
43+
# then, from anywhere in the repo, start Typesync
44+
hypergraph typesync
3045
```
3146

3247
## Commands

β€Ždocs/docs/faucet.mdβ€Ž

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Geo Testnet Faucet
3+
description: Request GEO tokens for development and testing on the Geo Testnet.
4+
---
5+
6+
# πŸͺ™ Geo Testnet Faucet
7+
8+
Need some GEO testnet tokens to start building with Hypergraph? Use our public faucet to quickly top-up your wallet.
9+
10+
[**Open the Geo Faucet**](https://faucet.conduit.xyz/geo-test-zc16z3tcvf)
11+
12+
## How it works
13+
14+
1. Switch your wallet/network to **Geo Testnet**.
15+
2. Navigate to the faucet URL above and connect your wallet.
16+
3. Click **Request tokens**. You should receive GEO in a few seconds.
17+
18+
That's it! You can now use the test tokens with any Hypergraph-powered app running on the Geo Testnet.
19+
20+
> Tip: If you run out of test tokens, come back to the faucet and request again (rate-limited to prevent abuse).
21+
22+
---
23+
24+
### Edit on GitHub :bust_in_silhouette:
25+
26+
[✏️ Improve this page](https://github.com/graphprotocol/hypergraph/edit/main/docs/docs/faucet.md)

β€Ždocs/sidebars.jsβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ const sidebars = {
1818
// By default, Docusaurus generates a sidebar from the docs folder structure
1919
docs: [
2020
{ type: 'doc', id: 'quickstart', label: 'πŸš€ Quickstart' },
21+
{ type: 'doc', id: 'faucet', label: 'πŸͺ™ Testnet Faucet' },
2122
{ type: 'doc', id: 'key-features', label: '🌟 Key Features' },
2223
{ type: 'doc', id: 'core-concepts', label: '🧠 Core Concepts' },
2324
{ type: 'doc', id: 'api-reference', label: 'πŸ“š API Reference' },

0 commit comments

Comments
Β (0)