Skip to content

Latest commit

 

History

History
156 lines (105 loc) · 5.07 KB

README.md

File metadata and controls

156 lines (105 loc) · 5.07 KB
Raw

Kickbase Live

Kickbase Live is an alternative web client for viewing matchday performances.

Note: This is a hobby project and was used for educational purposes to exercise and improve my skills while attending a reactjs training. I am not associated with Kickbase in any relation or responsible for the data provided by their API. I am not storing or analyzing any information/data within or outside the app. All data is stored inside your browsers local storage or indexed db.

Summary

Kickbase Live is an alternative web client for viewing performances of all matchdays. It uses the official Kickbase API v4 to retrieve the necessary data. The look is inspired by Kickbase and combines the Kickbase v3 layout with some of the new Kickbase v4 design patterns.

Table of Contents

Features

  • Switch between your leagues
  • View past and running matchdays
  • Squad performance (your own and all other league manager)
  • Matchday results
  • Team players performance (specific match or all time)
  • Manager ranking
  • Team ranking
  • Top 25
  • Competition Leaderboard
  • Install as a progressive web app for mobile or desktop

Demo

You can test this app with a demo I deployed on firebase hosting: https://kickbase-live.web.app/

Important information:

I am not storing your credentials. After the login the app makes a request to the offical Kickbase API to authenticate your account with their services. The app will receive an access token which will be stored locally in your browser. You can delete any data by logging out or deleting the application storage in the application tab within your browsers developer tools. The access token is valid for 7 days and you will be automatically logged out after it expires.

The demo website should be only used for testing or demonstration purposes. This way you dont have to donwload the source code and you can have an initial look at the application. It uses a free hosting tier on firebase which is limited to 360MB traffic per day. So it might happen that website is not available when the limit is exceeded. If you want to fully benefit from this project you have to host it yourself or download and run it locally.

Setup

Tested with Node v20.9.0

Clone the repository

git clone https://github.com/simonsagstetter/kickbaselive.git

Navigate to project directory

cd kickbaselive/

Install all dependencies

npm install

For development

npm run dev
  ➜  Local:   http://localhost:5173/
  ➜  Network: http://0.0.0.0:5173/
  ➜  press h + enter to show help

Generate a production build

npm run build

Preview and test a production build

npm run preview
  ➜  Local:   http://localhost:4173/
  ➜  Network: http://0.0.0.0:4173/
  ➜  press h + enter to show help

API

Im using the Kickbase v4 Endpoints which I have documented in my Kickbase API v4 Docs.

Contributing

Contributions are welcome! Please see into CONTRIBUTING.md for details on the code of conduct and submission process.

Roadmap

  • Player details
    • Season perfomance and stats
    • Market value insights
    • A performance evaluation algorithm
    • Player event history for the currently active matchday
  • Show match events and announced team lineup when clicking on the score within "standings" tab

Contributors

simonsagstetter
simonsagstetter

License

This project is licensed under the MIT License - see the LICENSE file for details