Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dandoh/web-haskell-graphql-postgres-boilerplate
Modern webserver in Haskell: Graphql + Postgresql + Authentication + DB migration + Dotenv and more
https://github.com/dandoh/web-haskell-graphql-postgres-boilerplate
database dbmate graphql graphql-api graphql-server haskell jwt jwt-authentication migration morpheus opaleye postgresql scotty stack stack-haskell typesafe web webserver webserver-setup
Last synced: about 2 months ago
JSON representation
Modern webserver in Haskell: Graphql + Postgresql + Authentication + DB migration + Dotenv and more
- Host: GitHub
- URL: https://github.com/dandoh/web-haskell-graphql-postgres-boilerplate
- Owner: dandoh
- License: mit
- Created: 2020-01-06T16:42:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-29T14:22:35.000Z (over 1 year ago)
- Last Synced: 2024-02-17T10:38:24.995Z (7 months ago)
- Topics: database, dbmate, graphql, graphql-api, graphql-server, haskell, jwt, jwt-authentication, migration, morpheus, opaleye, postgresql, scotty, stack, stack-haskell, typesafe, web, webserver, webserver-setup
- Language: Haskell
- Homepage:
- Size: 117 KB
- Stars: 122
- Watchers: 5
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE
Awesome Lists containing this project
README
# Modern Haskell Webserver Boilerplate
- Graphql API
- morpheus-graphql (https://github.com/morpheusgraphql/morpheus-graphql)
- Schema is in `schema.graphql`
```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`:
```terminal
$ cp .env.default .env
```
```env
DATABASE_URL="postgres://Dandoh:[email protected]:5432/webhaskell?sslmode=disable"
JWT_SECRET="my_jwt_secret"
```
- Migrations
```terminal
$ dbmate up
```
- More uses refer https://github.com/amacneil/dbmate
- Run webserver
```terminal
$ stack run
```
Now GraphQL API is at [http://localhost:8080/api](http://localhost:8080/api)
You can also access Graphql Playground at [http://localhost:8080/graphiql](http://localhost:8080/graphiql)
## Running on Docker
- Feed in you database & secret in `.env`:
```terminal
$ cp .env.default .env
```
- (Optional) Edit anything you need in the .env file
- Create and start docker containers
```terminal
$ 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
```terminal
$ docker-compose up dbmate
```
- Stack will restart whenever you change any .hs file, thanks to [entr](http://eradman.com/entrproject/)
## Contributors
PR are more than welcome. The only note is we use `ormolu` to format codes.
- [Nhan Thai](https://github.com/dandoh)
- [Pacific01](https://github.com/Pacific01)
- [Emad Shaaban](https://github.com/emadshaaban92)