The module to get the events of a Twitch channel ('cause there is no doc for it)
Install with npm :
npm install --save @lund-org/twitch-events
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
You can find an example of http integration in the static folder. It's also what is launched when you test the module.
If you have Docker, you don't need anything on your computer.
If you don't have Docker, you need node >= 9
and npm >= 6
.
For Docker users :
# If you're an Unix user and you have npm
npm run docker
# If you're an Unix user and you don't have npm
docker-compose -f etc/docker/docker-compose.yml up --build dev
# If you're a Windows user and you have npm
npm run windocker
# If you're a Windows user and you don't have npm
docker-compose.exe -f etc/docker/docker-compose.yml up --build dev
For Node/Npm users :
npm install
npm run dev
For Node/Npm users :
npm install
npm run test
The package is build by Travis and is available here
The environment variables are only used from tests.
TWITCH_USERNAME
: Represent a twitch username who has provided incoming events.TWITCH_USERNAME_EMPTY
: Represent a twitch username who has never provided any event.TWITCH_USERNAME_NOT_FOUND
: Represent a twitch username who's not found.
- Twith GQL API - The twitch dev portal
Contact us to know how to contribute.
We use SemVer for versioning. For the versions available, see the tags on this repository.
This project is licensed under the MIT License - see the LICENSE.md file for details