README.md
[![MIT License][shield-mit]][license]
[![Travis CI][shield-travis-ci]][travis-ci]
[![Circle CI][shield-circle-ci]][circle-ci]
[![Netlify Status][shield-netlify]][netlify]
[![Maintainability][shield-maintainability]][maintainability]
# react-twitch-streamers
🖥 React web app for displaying twitch streamers with the usage of Twitch API
Try the demo at
[https://twitch-streams.netlify.com](https://twitch-streams.netlify.com).
## Quick Setup
Install all of the application's dependencies:
`yarn install` or `npm install`
Next, you can start the application in a local environment with:
`yarn dev` or `npm run dev`
Open your browser to `http://localhost:3000` to see the app running.
Otherwise, you can build the application into a `<rootDir>/build` directory
with:
`yarn build` or `npm run build`
After that you can serve the optimized build at `http://localhost:8080` by
default locally with:
`yarn serve` or `npm run serve`
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request! :D
[circle-ci]: https://circleci.com/gh/john-d-pelingo/react-twitch-streamers
[license]:
https://github.com/john-d-pelingo/react-twitch-streamers/blob/master/LICENSE
[maintainability]:
https://codeclimate.com/github/john-d-pelingo/react-twitch-streamers/maintainability
[netlify]: https://app.netlify.com/sites/twitch-streams/deploys
[shield-circle-ci]:
https://circleci.com/gh/john-d-pelingo/react-twitch-streamers.svg?style=svg
[shield-maintainability]:
https://api.codeclimate.com/v1/badges/7c4add2fc81135bb30a9/maintainability
[shield-mit]: https://img.shields.io/badge/License-MIT-lavender.svg
[shield-netlify]:
https://api.netlify.com/api/v1/badges/c24ada41-0375-4121-b730-9c09b6f45490/deploy-status
[shield-travis-ci]:
https://travis-ci.org/john-d-pelingo/react-twitch-streamers.svg?branch=master
[travis-ci]: https://travis-ci.org/john-d-pelingo/react-twitch-streamers