https://github.com/derektypist/twitch-json-api
https://github.com/derektypist/twitch-json-api
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/derektypist/twitch-json-api
- Owner: derektypist
- Created: 2021-07-08T08:37:23.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-08T17:08:00.000Z (almost 5 years ago)
- Last Synced: 2025-08-13T23:34:31.640Z (10 months ago)
- Language: JavaScript
- Size: 178 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Twitch JSON API
The purpose of this project is to provide a Twitch JSON API that is functionally similar to
https://codepen.io/freeCodeCamp/full/Myvqmo/
## UX
As a user, I can see whether freeCodeCamp is currently streaming on Twitch.tv.
As a user, I can click the status output and be sent directly to the freeCodeCamp's Twitch.tv channel.
As a user, if a Twitch user is currently streaming, I can see additional details on what they are streaming.
Array of the Twitch.tv users who regularly stream are ["ESL_SC2","OgamingSC2","cretetion","freecodecamp","storbeck","habathcx","RobotCaleb","noobs2ninjas"].
[Wireframe](wireframes/wireframe-twitch-json-api.png) is included.
## Features
Allows you to filter online players, offline players and all players. Takes you to the Twitch Streaming Channel without leaving the page.
## Technologies
Uses HTML5, CSS3, JavaScript, jQuery 3.6.0, Bootstrap 5.0.2 and Google Fonts.
## Testing
Ensure that all user stories have been met.
## Deployment
Deployed on [GitHub Pages](https://derektypist.github.io/twitch-json-api) at the main branch.
## Credits
### Content
Taken from https://codepen.io/freeCodeCamp/full/Myvqmo/ and GitHub Repository of RyKizil.
Documentation about Twitch.tv's JSON API at https://dev.twitch.tv/docs/api/reference/#get-streams
GitHub Repository of RyKizil in the Twitch.tv JSON API (Did a GitHub Search in twitch-json-api)
### Acknowledgements
- [freeCodeCamp](https://www.freecodecamp.org)
- [Twitch.tv](https://twitch.tv)
- [RyKizil](https://github.com/RyKizil/TwitchTv-json-api/blob/master/main.js)
- [DummyImage](https://www.dummyimage.com)