Merge branch 'main' of github.com:graphprotocol/hypergraph into chris.whited/feat-typesync-pkg/mapping-generation

Author: cmwhited

.DS_Store

@@ -0,0 +1,18 @@
+# See https://fly.io/docs/app-guides/continuous-deployment-with-github-actions/
+
+name: Fly Deploy (Paused)
+on:
+  push:
+    branches:
+      - main
+jobs:
+  deploy:
+    name: Deploy app
+    runs-on: ubuntu-latest
+    concurrency: deploy-group # optional: ensure only one action runs at a time
+    steps:
+      - uses: actions/checkout@v4
+      # - uses: superfly/flyctl-actions/setup-flyctl@master
+      # - run: flyctl deploy --remote-only
+      #   env:
+      #     FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}

.github/workflows/fly-deploy.yml

@@ -66,4 +66,9 @@ typings/
 
 # typescript
 *.tsbuildinfo
-next-env.d.ts
+next-env.d.ts
+
+.DS_Store
+
+# tanstack router output
+.tanstack

.gitignore

@@ -0,0 +1 @@
+22

.nvmrc

@@ -0,0 +1,58 @@
+# Contributing
+
+## Upgrading Dependencies
+
+```sh
+pnpm up --interactive --latest -r
+```
+
+## Publishing
+
+```sh
+pnpm build
+# publish hypergraph
+cd packages/hypergraph/publish
+pnpm publish
+# publish hypergraph-react
+cd packages/hypergraph-react/publish
+pnpm publish
+# publish typesync
+cd apps/typesync
+pnpm publish --tag latest
+```
+
+## Deploying your own SyncServer to Fly.io (single instance)
+
+```sh
+# change the name of the `app` and `primary_region` in the fly.toml file
+
+# create a volume for the sqlite db file - replace `fra` with your region
+fly volumes create data -s 1 -r fra
+
+# set the DATABASE_URL (not sure if it's necessary since already set in the Dockerfile)
+fly secrets set DATABASE_URL=file:/data/production.sqlite
+# set the Privy app secret, id and chain (fill in your values)
+fly secrets set PRIVY_APP_SECRET=<PRIVY_APP_SECRET>
+fly secrets set PRIVY_APP_ID=<PRIVY_APP_ID>
+fly secrets set HYPERGRAPH_CHAIN=<HYPERGRAPH_CHAIN>
+
+# deploy (ha=false to avoid starting multiple instances)
+fly launch --ha=false
+
+# probably not necessary, but better safe than sorry
+fly scale count 1
+```
+
+Resources:
+- https://fly.io/docs/js/prisma/sqlite/
+- https://programmingmylife.com/2023-11-06-using-sqlite-for-a-django-application-on-flyio.html
+- https://community.fly.io/t/backup-and-restore-sqlite-db-to-server/21232/2
+
+### Multi-region deployments
+
+As an alternative you might want to setup a lite-fs volume for multi-region deployments.
+
+Resources:
+- https://github.com/epicweb-dev/node-sqlite-fly-tutorial/tree/main/steps
+- https://www.epicweb.dev/tutorials/deploy-web-applications/multi-region-data-and-deployment/prepare-for-multi-region-data-with-litefs
+- https://fly.io/docs/litefs/speedrun/

CONTRIBUTING.md

@@ -24,10 +24,10 @@ RUN --mount=type=cache,id=workspace,target=/root/.local/share/pnpm/store pnpm in
 # Build stage for the server.
 FROM base AS build
 # TODO: Remove this when we switch to an actual database.
-ENV DATABASE_URL="file:./dev.db"
+ENV DATABASE_URL="file:/data/production.sqlite"
 RUN \
   # TODO: This initalizes the database. But we should probably remove this later.
-  pnpm --filter server prisma migrate reset --force && \
+  # pnpm --filter server prisma migrate reset --force && \
   # Build the monorepo packages
   pnpm build && \
   # Generate the prisma client
@@ -37,13 +37,19 @@ RUN \
   # Create an isolated deployment for the server.
   pnpm --filter server deploy --prod deployment --legacy && \
   # Move the runtime build artifacts into a separate directory.
-  mkdir -p deployment/out && mv deployment/dist deployment/prisma deployment/node_modules deployment/package.json deployment/out
+  mkdir -p deployment/out && mv deployment/dist deployment/node_modules deployment/package.json deployment/out && \
+  # Add prisma client in dist
+  mv deployment/prisma/generated/client/libquery_engine-linux-musl-arm64-openssl-3.0.x.so.node deployment/out/dist/libquery_engine-linux-musl-arm64-openssl-3.0.x.so.node && \
+  mv deployment/prisma/generated/client/libquery_engine-linux-musl-openssl-3.0.x.so.node deployment/out/dist/libquery_engine-linux-musl-openssl-3.0.x.so.node && \
+  mv deployment/prisma deployment/out
 
 # Slim runtime image.
 FROM node:22-alpine AS server
 WORKDIR /app
 COPY --from=build /workspace/deployment/out .
 # TODO: Remove this when we switch to an actual database.
-ENV DATABASE_URL="file:./dev.db"
+ENV DATABASE_URL="file:/data/production.sqlite"
+RUN npm run prisma migrate deploy --skip-generate
 EXPOSE 3030
-CMD ["node", "dist/index.js"]
+# can't use fly.io release_command because it doesn't mount the volume containing the sqlite db file
+CMD ["sh", "-c", "npm run prisma migrate deploy && node dist/index.js"]

Dockerfile

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Geo Browser, PB LLC and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

LICENSE

@@ -1,4 +1,16 @@
-# Graph Framework
+# Hypergraph
+
+Hypergraph is a local-first framework for building web3 consumer applications.
+
+*Status: Developer Preview* Don't use in production!
+
+Build privacy preserving apps with interoperable data using the GRC-20 standard. Read the [Docs](https://docs.hypergraph.thegraph.com/docs/core-concepts), and get started using the Geo Testnet.
+
+* TypeSync - A development environment for creating and managing your app schemas
+* Geo Connect - An authentication app for granting your app permissions to user's private spaces
+* GRC-20 TS - A knowledge graph SDK for writing and publishing knowledge in the GRC-20 format
+* Hypergraph - A local-first framework for building web3 consumer applications
+* Hypergraph React - React bindings for Hypergraph
 
 ## Development
 
@@ -8,6 +20,7 @@
 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
 ```
 
@@ -30,7 +43,25 @@ cd apps/server
 pnpm prisma migrate dev # this will also generate the Prisma client
 ```
 
-You can run the next example app with:
+To develop the Typesync CLI, you can run:
+
+```sh
+cd apps/typesync
+pnpm dev
+```
+
+To develop the Typesync frontend run:
+
+```sh
+# open the vite.config.ts and comment out the server object that specifies the port to be 3000
+cd apps/typesync
+pnpm run dev:cli
+# in another tab
+cd apps/typesync
+pnpm dev:client
+```
+
+You can run the Next example app with:
 
 ```sh
 # Notes:
@@ -39,8 +70,9 @@ cd apps/next-example
 pnpm dev
 ```
 
-## Upgrading Dependencies
+To run the docs locally, you can run:
 
 ```sh
-pnpm up --interactive --latest -r
+cd docs
+pnpm start
 ```

README.md

@@ -0,0 +1,9 @@
+VITE_HYPERGRAPH_SYNC_SERVER_ORIGIN="http://localhost:3030"
+VITE_HYPERGRAPH_CHAIN="geo-testnet"
+VITE_HYPERGRAPH_API_URL="https://v2-postgraphile.up.railway.app/graphql"
+VITE_HYPERGRAPH_RPC_URL="https://rpc-geo-test-zc16z3tcvf.t.conduit.xyz"
+VITE_PRIVY_APP_ID="cmbhnmo1x000bla0mxudtd8z9"
+VITE_PRIVY_PROVIDERS="development"
+# VITE_HYPERGRAPH_CHAIN="geogenesis"
+# VITE_HYPERGRAPH_API_URL="https://hypergraph-v2.up.railway.app/graphql"
+# VITE_HYPERGRAPH_RPC_URL="https://rpc-geo-genesis-h0q2s21xx8.t.conduit.xyz"

apps/connect/.env.development

@@ -0,0 +1,7 @@
+# VITE_HYPERGRAPH_SYNC_SERVER_ORIGIN="https://syncserver.hypergraph.thegraph.com"
+VITE_HYPERGRAPH_SYNC_SERVER_ORIGIN="https://hypergraph.fly.dev"
+VITE_HYPERGRAPH_CHAIN="geo-testnet"
+VITE_HYPERGRAPH_API_URL="https://v2-postgraphile.up.railway.app/graphql"
+VITE_HYPERGRAPH_RPC_URL="https://rpc-geo-test-zc16z3tcvf.t.conduit.xyz"
+VITE_PRIVY_APP_ID="cmcccikza007bjy0niawgutl0"
+VITE_PRIVY_PROVIDERS="production"