dandoh/web-haskell-graphql-postgres-boilerplate

Modern webserver in Haskell: Graphql + Postgresql + Authentication + DB migration + Dotenv and more

Modern Haskell Webserver Boilerplate

• Graphql API
  • morpheus-graphql (https://github.com/morpheusgraphql/morpheus-graphql)
  • Schema is in schema.graphql

    type User {
        id: Int!
        email: String!
        name: String!
        updatedAt: String!
        createdAt: String!
    }
  
    type Session {
        token: String!
        user: User!
    }
  
    type Query {
        login(email: String!, password: String!): Session!
        myUserInfo: User!
    }
  
    type Mutation {
        register(email: String!, password: String!, name: String!): Session!
        changePassword(oldPassword: String!, newPassword: String!): Boolean!
    }

• Database:
  • Postgresql + Opaleye
  • Migration using dbmate (https://github.com/amacneil/dbmate)
  • Pooling using Data.Pool

This boilerplate wires up:

• Reading .env using envy
• Database
• Graphql API
• Authorization using JWT
• Monad transformers

Running

• Feed in you database & secret in .env:

  $ cp .env.default .env
  

  DATABASE_URL="postgres://Dandoh:[email protected]:5432/webhaskell?sslmode=disable"
  JWT_SECRET="my_jwt_secret"

• Migrations

  $ dbmate up
  

  • More uses refer https://github.com/amacneil/dbmate
• Run webserver

  $ stack run
  

Now GraphQL API is at http://localhost:8080/api

You can also access Graphql Playground at http://localhost:8080/graphiql

Running on Docker

• Feed in you database & secret in .env:

  $ cp .env.default .env
  

• (Optional) Edit anything you need in the .env file

• Create and start docker containers

  $ docker-compose up
  

• Now you can visit: http://localhost:8080/ in your local machine.

• Migrations will automatically run, and you can run them manually anytime using

  $ docker-compose up dbmate
  

• Stack will restart whenever you change any .hs file, thanks to entr

Contributors

PR are more than welcome. The only note is we use ormolu to format codes.

• Nhan Thai
• Pacific01
• Emad Shaaban

web-haskell-graphql-postgres-boilerplate's Issues

Just get the string 'Not Found'

Hi, I migrate the database but when I go to localhost all I get is the string 'Not found' in the browser.

error: JSON.parse

Hi, I think I set this up correctly and I'm using the query

query {
  myUserInfo {
    name
  }
}

but I just get this error with no much information

{
  "error": "JSON.parse: unexpected character at line 1 column 1 of the JSON data"
}

I admit I don't know graphql that well but what can I do to get a more useful error?

Update template to GHC 9.4.4

Hi, this template looks amazing and it is just what I was looking for!

However, since it is 3 years old and I'm trying to build it with an M1, stack and ghc versions are too old, maybe this could be updated? 🙏🏻

Thanks in advance!

Integrate Haxl for batching queries

License on the project will be good

Hello.

First of all I wat to thank you (@dandoh) for this boilerplate. It helps me, a lot, to understand how to make a setup for a Haskell web application. I have use it in on of my side project as my base, which led me to think about whether I can use it or not license wise.

It will be great if it can has some license.

I have seen a lot of BSD-3-Clause and MIT aswell in the haskell comunity and both of them will be okay.

Thank you.

Array Objects

Hello,

I noticed that in the most recent commit, things like MaybeObject and ArrayObject were removed in favor of Composed. I was originally trying to return an array of Users with ArrayObject and have since updated to Composed, but either way I have not been able to get it compiling. Would it be possible to include an example that implements the following query?

type Query {
  ...
  allUsers: [User!]!
  ...
}

I tried looking at the morpheus documentation as well, but it looks quite different from the patterns used here. I'm new so I'm sure I'm missing something but any help would be appreciated!