strimertul/README.md

# Strimertül

Smol broadcasting suite, includes:

- Extremely simple/fast disk-backed KV over websocket (Kilovolt) for interacting with web-based overlays
  - oh 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
  - WIP betting system
- Twitch IRC bot to tie everything together
- WIP own backend integration (stulbe)

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

## 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
Update readme 2021-05-02 12:39:37 +00:00			`Smol broadcasting suite, includes:`
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			`- Extremely simple/fast disk-backed KV over websocket (Kilovolt) for interacting with web-based overlays`
First public commit \o/ 2021-05-02 12:29:43 +00:00			`- oh 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`
			`- WIP betting system`
			`- Twitch IRC bot to tie everything together`
			`- WIP own backend integration (stulbe)`

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

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).