go-graphql-sse-example

Basic example application to demonstrate an alternative way of building web APIs compared to REST. It combines these technologies:

• Go as the primary backend-side language
• GraphQL as a "protocol" for defining web interfaces
• Server-Sent Events as a simple protocol for live updates, used as an implementation of GraphQL Subscriptions here
• MongoDB as a flexible document database for storage
• VueJS as a frontend framework to build single-page web applications

This project is intended to serve as a starting point to build modern, GraphQL-based single-page web application with a clean, opinionated code structure in backend and frontend.

Original blog post

Inspired by:

• OscarYuen/go-graphql-starter
• andoshin11/clean-architecture-example-vue

Requirements

• Go >= 1.13
• NodeJS >= 12.8.x
• A MongoDB database
  • You can get a free one at mlab.com

Usage

Backend (/)

• Edit config.yml to configure your database
• Set up the database (i.e. add users, collections and demo data)
• Compile the GraphQL schema (located in schema) to Go code: ./generate_schema.sh
• Compile the server code: GO111MODULE=on go build
• Run the server: ./go-sse-graphql-example

Frontend (/web)

• Go to web
• Install dependencies: yarn install
• Run the frontend for development: yarn serve
• Go to http://localhost:4000

The interactive GraphQL explorer can be accessed at http://localhost:8080/graphiql. You can find example queries here.

Limitations

• This example focuses primarily on the backend and the data flow between front- and backend. Accordingly, the UI is not very beautiful.
• Only very basic business logic is implemented, just enough to demonstrate the above concepts on a real-world example.

Still to do

The current state of this project is a very basic working example. However, in order to use this as a base to build a fully-fledged application, there are still a few things missing, including the following.

• Authentication and authorization for GraphQL methods
• Caching and / or implementation of a Dataloader for efficiency

Hopefully, I will have enough time to supplement these features in the future.

License

MIT