Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/HearthSim/Joust

🍿 Hearthstone replays in your browser.
https://github.com/HearthSim/Joust

hearthstone hsreplay replays

Last synced: 6 days ago
JSON representation

🍿 Hearthstone replays in your browser.

Awesome Lists containing this project

README

        

# Joust
[![GitHub release](https://img.shields.io/github/release/HearthSim/Joust.svg)](https://github.com/HearthSim/Joust/releases)

Hearthstone replays in your browser, written in Typescript with React.

## Requirements

- Node.js ~v8 (v4.5 should also work, but is not officially supported)
- Build system: `npm install -g gulp webpack`
- Development: `npm install -g electron-prebuilt gulp webpack`
- [yarn](https://yarnpkg.com/): `npm install -g yarn`

## Building

```
$ yarn --pure-lockfile
$ gulp compile
```

## Usage

```html

Joust.launcher("joust-container")
.height(500)
.width(500)
.fromUrl("//example.org/brawl.hsreplay");

```

[Full documentation](https://github.com/HearthSim/Joust/wiki/Embedding).

Joust does not do any polyfilling and expects the globals Promise and fetch to be available.

## Development

```
$ yarn run dev
```

## License

Copyright © HearthSim. All Rights Reserved.

### Third party assets

- The Font Awesome font is licensed under the SIL OFL 1.1.
- The Font Awesome style code is licensed under the MIT license.
- Some Hearthstone textures are copyright © Blizzard Entertainment

## Community

This is a [HearthSim](https://hearthsim.info) project. All development
happens on our IRC channel `#hearthsim` on [Freenode](https://freenode.net).