Skip to content

Commit

Permalink
docs: better README for the example
Browse files Browse the repository at this point in the history
  • Loading branch information
XiNiHa committed Dec 16, 2024
1 parent f76d26b commit bba3348
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion example/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,20 @@
# solid-relay-example
# Solid Relay Example

This is a SolidStart project that uses Solid Relay, demonstrating various features:

- Basic GraphQL/Relay features like queries, fragments, mutations, paginations, etc.
- Suspense and Transitions integration
- SSR support, including streaming of `@defer`red queries
- Preloading support with Solid Router
- Server side fetching with `"use server"` on the network layer

## Running the example

Due to a Relay compiler requirement, [Watchman](https://facebook.github.io/watchman/) should be installed to run the compiler in watch mode.

```sh
pnpm i
pnpm dev
```

The command will launch the SolidStart dev server, the Relay compiler, and the example GraphQL API server.

0 comments on commit bba3348

Please sign in to comment.