graphql-pothos-server-example

KO | EN

gitlite — search

#llm #android #machine-learning #rust #windows #awesome #awesome-list #vue #pytorch #security #ios #openai #mcp #open-source

graphql-pothos-server-example

(★ 44)

Example implementation of the Pothos (formerly GiraphQL) library to create a GraphQL server with queries, mutations, and subscriptions along with unit and integration tests.

graphql-pothos-server-example Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Pothos GraphQL Server Example

This repo demonstrates how to use the graphQL code-based 
[pothos](https://pothos-graphql.dev) (formerly named `giraphql`) library to build queries,
mutations, subscriptions, and add directives.

It also includes sample `jest` tests.

It is written using Typescript.

Components:

- [pothos](https://pothos-graphql.dev)
- [Apollo Server](https://www.apollographql.com/docs/apollo-server/)
- [Apollo Server Express](https://www.npmjs.com/package/apollo-server-express)
- [graphql-ws](https://github.com/enisdenjo/graphql-ws) for subscriptions and as a testing client for subscriptions
- [Sequelize ORM w/ sqlite](https://sequelize.org/master/)
- [sequelize-typescript](https://www.npmjs.com/package/sequelize-typescript) for defining `sequelize` models
- [dataloader-sequelize](https://github.com/mickhansen/dataloader-sequelize) as a [dataloader](https://www.apollographql.com/docs/apollo-server/data/data-sources/#using-with-dataloader) provider for `sequelize`
- [graphql-playground](https://github.com/graphql/graphql-playground)
- [graphql-codegen](https://www.graphql-code-generator.com/) to generate the schema file and typescript definitions for frontend consumption, along with a fully-typed GQL client

## Installing

node.js v14 is the baseline requirement.

`$ yarn`

## Running

`$ yarn dev`

The server will start on port `3000`.

- GQL API: `http://localhost:3000/graphql`
- Playground: [http://localhost:3000/playground](http://localhost:3000/playground)

## Tests

Run unit tests with:

`$ yarn test:unit`

Integration tests:

`$ yarn test:integration`

## Schema + Typescript definition generation

You can use the [`graphql-codegen`](https://www.graphql-code-generator.com/) generated files with your frontend for type information when calling the server.

`$ yarn generate`

Generated files are located in the `gql-schema` directory.

The following plugins are used:

- [typescript](https://www.graphql-code-generator.com/docs/plugins/typescript)
- [typescript-apollo-client-helpers](https://www.graphql-code-generator.com/docs/plugins/typescript-apollo-client-helpers)

## Directory structure

In the `src/` folder:

- `datasources/`: Apollo datasources for making db calls
- `db/`: Sequelize models
- `gql/`: `pothos` definitions

The `gql/` folder is organized by domain. The reason I've done this vs organizing
by queries or mutations is the following:

- `pothos` is a code-based gql definition library. Because it's code-based, you have a lot of control
on how to define your graphQL items. The trade-off is that it's more verbose. If you were to
shove everything under a single query or mutation file, it would be extremely difficult to navigate and read.
- Types themselves can have multiple resolvers that are independent of a query or mutation and can alone be quite verbose / complex.
- It's easier to find files that are specific to the function in an IDE. For example, the post creation mutation can be easily discovered in file search.
- All the code for that specific function lives in a single file makes it easier to bounce back and forth from vs jumping between files.

## Sample queries

Here's some queries to try out in the playground:

Create a user and post:

```gql
mutation {
  createUser(input: {
    name:"Theo Gravity"
  }) {
    user {
      id
    }
  }
  createPost(input:{
    authorId: 1
    title:"Test title",
    content:"Test post"
  }) {
    id
  }
}
```

Query for user posts:

```gql
query {
  user(id: 1) {
    id
    name
    posts {
      id
      title
      content
      created
    }
  }
}
```

Get users:

```gql
query {
  users {
    id
    name
  }
}
```

Get posts:

```gql
query {
  posts {
    id
    title
    content
    created
    author {
      name
    }
  }
}
```

graphql-pothos-server-example

graphql-pothos-server-example Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

graphql-pothos-server-example

graphql-pothos-server-example Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README