Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/reasnovynt/skorboard

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/reasnovynt/skorboard
Owner: reasnovynt
License: mit
Created: 2024-08-17T10:01:13.000Z (5 months ago)
Default Branch: master
Last Pushed: 2024-08-18T01:58:51.000Z (5 months ago)
Last Synced: 2024-08-18T17:12:13.971Z (5 months ago)
Language: JavaScript
Size: 279 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Skorboard

Skorboard is a static application for calculating multi-game scores with an easy-to-use interface using Vite + ReactJS.

## Showcase

**Demo**: [https://reasnovynt.github.io/skorboard](https://reasnovynt.github.io/skorboard)

![Screenshot of the app](public/showcase/skorboard-screenshot.png)

## Features

- Game duration settings
- Customizable player names
- Score adjustments for two players
- Countdown timer
- Game over notifications and winner announcements

## Installation

### Clone the Repository

```bash
git clone https://github.com/reasnovynt/skorboard.git
cd skorboard
```

### Install Dependencies

Ensure you have [Bun](https://bun.sh/) installed on your system. Then, install the project dependencies using the following command:

```bash
bun install
```

### System Requirements

- [Bun](https://bun.sh/) ^1.1.24

## Usage

1. **Run the Application in Development Mode**

To start the application in development mode, use the following command:

```bash
bun dev
```

2. **Build the Application for Production**

To build the application for production, use the following command:

```bash
bun build
```

3. **Run the Production Application**

To run the application in production mode, use the following command after building the application:

```bash
bun start
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for information on how to contribute to this project.

## License

This project is licensed under the [MIT License](LICENSE).