strimertul/README.md

# Strimertül

Small broadcasting suite, includes:

- Extremely simple/fast disk-backed KV over websocket ([Kilovolt](https://github.com/strimertul/kilovolt)) for interacting with web-based overlays
  - and it has pub/sub!
- Static file server for said overlays
- Loyalty system that tracks viewers and allows them to redeem rewards and contribute to community goals
- Twitch IRC bot to tie everything together
- Backend integration ([stulbe](https://github.com/strimertul/stulbe))

Platform support is limited to Twitch only for the time being (sorry!)

## Getting started

Download the latest build from here: [github.com/strimertul/strimertul/releases/latest](https://github.com/strimertul/strimertul/releases/latest)

Start strimertul and the Web UI will appear when the app is done loading, you can start configuring and using it from there!

## Building

You need to build the frontend first!

```sh
cd frontend
npm i
npm run build
```

Once that's done, just build the app like any other Go project

```sh
go build
```

## License

Kilovolt's code is based on Gorilla Websocket's server example, licensed under [BSD-2-Clause](https://github.com/gorilla/websocket/blob/master/LICENSE)

The entire project is licensed under [AGPL-3.0-only](LICENSE) (see `LICENSE`). For ISC exceptions, see [LICENSING.md](LICENSING.md).
Update readme 2021-05-02 12:39:37 +00:00			`# Strimertül`
First public commit \o/ 2021-05-02 12:29:43 +00:00
Fix linting issues (Thanks GoLand!) 2021-10-28 09:01:52 +00:00			`Small broadcasting suite, includes:`
First public commit \o/ 2021-05-02 12:29:43 +00:00
Update README 2021-09-18 22:22:45 +00:00			`- Extremely simple/fast disk-backed KV over websocket ([Kilovolt](https://github.com/strimertul/kilovolt)) for interacting with web-based overlays`
Fix linting issues (Thanks GoLand!) 2021-10-28 09:01:52 +00:00			`- and it has pub/sub!`
First public commit \o/ 2021-05-02 12:29:43 +00:00			`- Static file server for said overlays`
			`- Loyalty system that tracks viewers and allows them to redeem rewards and contribute to community goals`
			`- Twitch IRC bot to tie everything together`
Fix linting issues (Thanks GoLand!) 2021-10-28 09:01:52 +00:00			`- Backend integration ([stulbe](https://github.com/strimertul/stulbe))`
First public commit \o/ 2021-05-02 12:29:43 +00:00
			`Platform support is limited to Twitch only for the time being (sorry!)`

Add getting started 2021-09-18 22:06:54 +00:00			`## Getting started`

			`Download the latest build from here: [github.com/strimertul/strimertul/releases/latest](https://github.com/strimertul/strimertul/releases/latest)`

			`Start strimertul and the Web UI will appear when the app is done loading, you can start configuring and using it from there!`

Update readme 2021-05-02 12:39:37 +00:00			`## Building`
First public commit \o/ 2021-05-02 12:29:43 +00:00
			`You need to build the frontend first!`

			```sh
			`cd frontend`
			`npm i`
			`npm run build`
			```

			`Once that's done, just build the app like any other Go project`

			```sh
			`go build`
			```

Update readme 2021-05-02 12:39:37 +00:00			`## License`
First public commit \o/ 2021-05-02 12:29:43 +00:00
Replace pub/sub with Badger's own implementation 2021-05-02 13:24:23 +00:00			`Kilovolt's code is based on Gorilla Websocket's server example, licensed under [BSD-2-Clause](https://github.com/gorilla/websocket/blob/master/LICENSE)`

First public commit \o/ 2021-05-02 12:29:43 +00:00			The entire project is licensed under [AGPL-3.0-only](LICENSE) (see `LICENSE`). For ISC exceptions, see [LICENSING.md](LICENSING.md).