Skip to content

liandeguo/brawlstats

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Brawl Stars Tracker

A simple web application to track your or others Brawl Stars Accounts

· Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing

About The Project

Brawl Stars Tracker Screen Shot

(back to top)

Built With

  • Svelte

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • npm
    npm install npm@latest -g

Installation

  1. Clone the repo
    git clone https://github.com/liandeguo/brawlstats.git
  2. Install NPM packages
    npm install
  3. Run it
    npm run dev

(back to top)

Roadmap

  • Battle Log
  • Show more infos about the Brawlers
  • Track the Trophies and show a graph

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

(back to top)