An angular web app that acts as a client for interacting with the Wolfpack RPG. The Wolfpack RPG was developed by Twitch streamer LobosJr, as part of the custom bot he wrote. This app was developed for and in collaboration with LobosJr, to act as the official client for the game to get around the issues with the Twitch whisper system.
The app is hosted on Github, and requires a Twitch account to log in. The app communicates directly with LobotJr, and as such will not work if that bot is not running in the LobosJr channel.
If your Twitch account is still new, you may not be able to send messages through a stand-alone client. This is due to a security measure Twitch takes against spam bots. Twitch will not say how long an account must be active before this feature is enabled.
This app was created using Angular CLI CLI 12.1.0. It requires Node 10.13.0 or higher, and NPM 6.11.0 or higher.
Before attempting to build the app locally, make sure you have installed all development requirements and cloned this repository.
In the repository root folder, run the start NPM command.
NPM run startThis will build the application and host it locally. Once it's finished compiling, you can access the app at http://localhost:4200/. Since this is an Angular project, it will detect changes in the code and update the server automatically as long as the command is still running.
To run the unit tests for this project, run the test NPM command.
NPM run testTo run the style tests for this project, run the lint NPM command.
NPM run lintDue to the dependency on Lobot being up and running, there are no e2e tests. Additional focus is placed on unit testing to compensate.
For deployment of a local version, run the deploy NPM command. This will create a dist folder containing everything you need to host the app.
NPM run deployTo update the main app hosted on Github, run the deploy-to-ghpages NPM command.
NPM run deploy-to-ghpagesNote that only authorized users are able to publish to the Github-hosted page.
We recommend using Visual Studio Code, with the following extensions:
Make sure to set your default formatter to use Prettier, as the default typescript formatter in VS Code will cause conflicts with the GTS style check. It is listed in the formatter selection as esbenp.prettier-vscode.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
We use SemVer for versioning. For the versions available, see the tags on this repository.
See also the list of contributors who participated in this project.
This project is licensed under the GPL 3.0 License - see the LICENSE.md file for details