https://github.com/ponjimon/owl-graphql

A GraphQL wrapper for the Overwatch League API made with the Serverless framework.
https://github.com/ponjimon/owl-graphql

api framework graphql layer overwatch overwatchleague owl owleague serverless wrapper

Last synced: 3 months ago
JSON representation

A GraphQL wrapper for the Overwatch League API made with the Serverless framework.

• Host: GitHub
• URL: https://github.com/ponjimon/owl-graphql
• Owner: Ponjimon
• Created: 2018-02-12T00:30:09.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-09-06T20:18:36.000Z (over 3 years ago)
• Last Synced: 2024-05-01T13:26:50.913Z (10 months ago)
• Topics: api, framework, graphql, layer, overwatch, overwatchleague, owl, owleague, serverless, wrapper
• Language: JavaScript
• Homepage:
• Size: 56.6 KB
• Stars: 11
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# OWL GraphQL

This repository is a GraphQL wrapper for the API of the Overwatch League

It is made with the [serverless framework](https://serverless.com)

![Example image](https://i.imgur.com/hBDjC8W.jpg)

## Install

1. Run `npm install` or `yarn install`

2. Rename `config.sample.js` to `config.js` and change the configuration (e.g. add a redis server for query caching, etc.)

3. Run `npm start` or `yarn start` to start *Serverless Offline* on `http://localhost:4000`

## Playgrounds

There are 2 playgrounds available. You can either use GraphiQL or GraphQL Playground like so:

`http://localhost:4000/graphiql`

`http://localhost:4000/playground`

The GraphQL API itself is reachable under:

`http://localhost:4000/graphql`

## Deploy

Run `npm run deploy-dev` or `yarn run deploy-dev` for deploying the API to AWS Lambda using serverless.

Same for `deploy-prod`.

`dev` and `prod` are the stages.

Don't forget to setup serverless appropriately.

## Misc

This project is currently WIP.