<div align="center">

[<img src="logo.svg" height="128">](https://bzlist.net)

## BZList

[![GitHub license](https://img.shields.io/github/license/bzlist/bzlist.net.svg)](https://github.com/bzlist/bzlist.net/blob/master/LICENSE)
![GitHub package.json version](https://img.shields.io/github/package-json/v/bzlist/bzlist.net)
[![Build Status](https://travis-ci.org/bzlist/bzlist.net.svg?branch=master)](https://travis-ci.org/bzlist/bzlist.net)
[![CD](https://github.com/bzlist/bzlist.net/workflows/CD/badge.svg)](https://github.com/bzlist/bzlist.net/actions?query=workflow%3ACD)
[![Netlify](https://img.shields.io/netlify/6aaaa6f8-575a-4432-a0b3-5402a2b4fb34)](https://bzlist.net)
<!--[![IRC #bzlist](https://img.shields.io/badge/IRC-%23bzlist-blue.svg)](http://webchat.freenode.net/?channels=#bzlist)-->

Socket.io + React = *(kind of)* real-time server stats for BZFlag.

</div>

The app is running at [bzlist.net](https://bzlist.net). The origonal version was made with Angular, and can be found [here](https://github.com/bzlist/bzlist.net-old).

You can view the changelog [here](CHANGELOG.md).

## Get started

It's easy to get started, just follow the few steps below.

### Get the code

You can get the code by either cloning the reposity (which is recommended) or downloading it as a ZIP file.

To clone the repository run the following (you must have Git installed).
```sh
git clone https://github.com/bzlist/bzlist.net.git
cd bzlist.net
```

The latest ZIP file can be found at [here](https://github.com/bzlist/bzlist.net/archive/master.zip).

### Install npm packages

```sh
npm install
```

## Available Scripts

### `npm start`

Runs the app in the development mode. Open [http://localhost:3000](http://localhost:3000) to view it in your browser and the page will live reload when you make edits.

### `npm run lint`

Lints the TypeScript and SCSS files in `src`.

### `npm run build`

Builds the app for production and outputs it to `build`. It correctly bundles React in production mode and optimizes the build for the best performance.

## License

Licensed under the [MIT license](LICENSE).
