Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/NGeniusGaming/ngenius-api

The NGenius Gaming API to support ngenius teamview
https://github.com/NGeniusGaming/ngenius-api

esports-api hacktoberfest open-source twitch

Last synced: 3 months ago
JSON representation

The NGenius Gaming API to support ngenius teamview

Awesome Lists containing this project

README

        

# NGenius API

> An API for handling data with the ngenius-teamview application!

## Requirements

This project requires:

- Java 11 (Any jdk will do!)
- Docker (If you want to build an image locally.)

## Running

To run this application, you'll need to provide some Twitch credentials!
Never fear though, anyone can get their own twitch credentials!

This application connects to Twitch via OAuth, therefore, you'll need to provide this application
your credentials!

Your environment should contain:

`TWITCH_CLIENT_ID` - set to your twitch client id.

`TWITCH_CLIENT_SECRET`- set to your twitch client secret.

[You can learn more about authenticating with Twitch in their developer docs](https://dev.twitch.tv/docs/authentication/#types-of-tokens)
.

#### Common Errors

If you get a stacktrace along these lines, you did not properly set your configuration environment variables.

```
There was an unexpected error (type=Internal Server Error, status=500).
Not enough variable values available to expand 'TWITCH_CLIENT_ID'
```

## Deployments

At this time, updates to the kubernetes ymls must be deployed manually (better solution hopefully coming soon!)

But, new applications are auto-deployed when the are committed to `master` :tada:.