diff --git a/README.md b/README.md index 93cb09e1..76b65426 100644 --- a/README.md +++ b/README.md @@ -24,18 +24,12 @@ 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 @@ -43,7 +37,7 @@ 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: @@ -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 diff --git a/apps/typesync/README.md b/apps/typesync/README.md index 3ebf260c..b1da4f36 100644 --- a/apps/typesync/README.md +++ b/apps/typesync/README.md @@ -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 diff --git a/docs/docs/faucet.md b/docs/docs/faucet.md new file mode 100644 index 00000000..fd63a592 --- /dev/null +++ b/docs/docs/faucet.md @@ -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) \ No newline at end of file diff --git a/docs/sidebars.js b/docs/sidebars.js index b22a9d95..0ada16bc 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -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' },