LiveScore

Share the results of an Unofficial Cubing Competition Live
No demo yet · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. Contact
7. Acknowledgments

About The Project

Results are a crucial part of cubing competitions. They can define whether or not someone advances to the next rounds, or what prices they win. I hated using spreadsheets for this and WCA Live doesn't support unofficial competitions.

Also since cubing competitions happen in KGP we don't really even need to deploy this anywhere, we can just expose it on the local network.

Livescore is designed to

• Allow for easy data entry
• Let others view their results

There's a lot of enhancements that can be added, but these are the design principles

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

First get an idea of what cubing competitions are like. You can read this and follow any of the given resources

• make sure you have pnpm installed. On Arch Linux

  sudo pacman -S pnpm

Installation

• install dependencies and set up backend

  cd backend/
  pnpm install
  node server.js

• same for frontend

  cd frontend/
  pnpm install
  pnpm run dev

(back to top)

Usage

(back to top)

Roadmap

• Fix Import from csv
• Containerise Project
• Add frontend README
• Add Backend README
• Add Authentication for backend request
  • this might be unnescary after containerisation though
• Add CRUD operations to the Database
• Add more tables for participants, just name isn't enough
• Improve styling
  • ugly rn :(
• Move backend from npm to pnpm and add a .gitignore

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Top contributors:

(back to top)

Contact

• Project Link: https://github.com/KGP-Speedcubers/live-results
• Discord Server: https://discord.gg/KQdGdB93Uc
  • join the #livescore channel

(back to top)

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!

• Best-README-Template
• Malven's Flexbox Cheatsheet
• Malven's Grid Cheatsheet
• Img Shields
• React Icons

(back to top)