https://github.com/zth/rescript-relay-github-example
An example of RescriptRelay, built on the GitHub GraphQL API.
https://github.com/zth/rescript-relay-github-example
Last synced: 11 months ago
JSON representation
An example of RescriptRelay, built on the GitHub GraphQL API.
- Host: GitHub
- URL: https://github.com/zth/rescript-relay-github-example
- Owner: zth
- Created: 2024-07-22T10:34:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-30T12:38:35.000Z (over 1 year ago)
- Last Synced: 2024-07-30T23:08:45.148Z (over 1 year ago)
- Language: JavaScript
- Size: 419 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# rescript-relay-starter
A starter for RescriptRelay. Features:
- [`rescript-relay-router`](https://github.com/zth/rescript-relay-router) for routing built to work best with Relay
- Vite for a fast workflow
- TailwindCSS
- Client side rendering (SSR coming soon)
## Get started
This uses [`graphql-client-example-server`](https://github.com/zth/graphql-client-example-server) by default. So, install and start that first if you want to have a look at the demo code included in the repo:
```bash
npm install -g graphql-client-example-server
# Then run it
graphql-client-example-server
```
```bash
npm i
# Run this to start developing
npm run dev
# Run this to build for production
npm run build
```
## Dev environment
If you're a VSCode user, make sure you install [`vscode-rescript-relay`](https://marketplace.visualstudio.com/items?itemName=GabrielNordeborn.vscode-rescript-relay), the official RescriptRelay extension. It provides a large number of tooling and conveniences both for working with RescriptRelay as well as with the RescriptRelayRouter itself.
## Future
More advanced starters and samples will be coming later, including with SSR (both regular and streaming) set up.
## Caveats
- `@defer` is not enabled yet. Will happen soon.