Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svelte-add/graphql-server
(out of date) A command to add a GraphQL server to your Svelte project
https://github.com/svelte-add/graphql-server
graphql graphql-helix graphql-server svelte svelte-add sveltekit
Last synced: about 2 months ago
JSON representation
(out of date) A command to add a GraphQL server to your Svelte project
- Host: GitHub
- URL: https://github.com/svelte-add/graphql-server
- Owner: svelte-add
- License: mit
- Created: 2020-11-25T05:58:11.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-17T00:10:20.000Z (almost 3 years ago)
- Last Synced: 2024-04-28T04:53:25.609Z (8 months ago)
- Topics: graphql, graphql-helix, graphql-server, svelte, svelte-add, sveltekit
- Language: TypeScript
- Homepage:
- Size: 93.8 KB
- Stars: 31
- Watchers: 5
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🕸 Add GraphQL to Svelte
## ❓ What is this?
This is an **experimental** command to run to add a GraphQL server (powered by [`graphql-helix`](https://github.com/contrawork/graphql-helix/)) to your SvelteKit project.
## 🛠 Usage
You must start with a fresh copy of the official SvelteKit template, which is currently created by running this command. **You must say yes to TypeScript preprocessing.**
```sh
npm init svelte@next
```
Once that is set up, run this command in your project directory to set up GraphQL:
```sh
npx svelte-add graphql-server
```
After the preset runs,
* You can create a GraphQL schema in `src/graphql/schema.ts` using any library or technique you want. Additionally, you can set the `defaultQuery` that shows up when GraphiQL is loaded in the browser.
* You can query your API (with POST requests) at the `/graphql` endpoint.
* You can visit GraphiQL in the browser at the `/graphql` endpoint.
* You can see an example of how you may set up resolver-level authorization with the `contextFactory` line in `src/routes/graphql.ts` and the `authorization` argument in `src/graphql/schema.ts`.
* The `/` route (in your `src/routes/index.svelte` file) will show an example of how to use your GraphQL API in `preload`.
* You [*cannot* use GraphQL subscriptions](https://github.com/svelte-add/graphql/issues/1).
* You can apply *another* [Svelte Adder](https://github.com/svelte-add/svelte-adders) to your project for more functionality.
## 😵 Help! I have a question
[Create an issue](https://github.com/svelte-add/graphql/issues/new) and I'll try to help.
## 😡 Fix! There is something that needs improvement
[Create an issue](https://github.com/svelte-add/graphql/issues/new) or [pull request](https://github.com/svelte-add/graphql/pulls) and I'll try to fix.
These are new tools, so there are likely to be problems in this project. Thank you for bringing them to my attention or fixing them for me.
## 📄 License
MIT
---
*Repository preview image generated with [GitHub Social Preview](https://social-preview.pqt.dev/)*
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_