Vacay Mania Brawl Club

Dashboard

Brief description of your project. What does it do? Why should people use it?

Table of Contents

• Table of Contents
• Features
• Usage
  • Prerequisites
  • Installation
  • Development
  • Build
  • Preview
  • Preview on Azure Static Web Apps
  • Type Checking
  • Linting and Formatting
• Contributing
  • Bug Reports
  • Feature Requests
  • Pull Requests
• License
• Credits

Features

• Win rate for each club member

Usage

Prerequisites

Before you start, make sure you have the following software installed on your machine:

• Node.js (v16 or later)
• npm or pnpm (we recommend using pnpm for faster installs)

Installation

1. Clone the repository:

   git clone https://github.com/thejoltjoker/vmbc-dashboard.git

2. Change into the project directory:

   cd vmbc-dashboard

3. Install dependencies using pnpm (or npm):

   pnpm install
   # or
   # npm install

Development

To run the project in development mode, use the following command:

pnpm dev
# or
# npm run dev

This will start the development server using Vite.

Build

To build the project for production, run:

pnpm build
# or
# npm run build

Preview

To preview the production build locally, use:

pnpm preview
# or
# npm run preview

Preview on Azure Static Web Apps

For previewing on Azure Static Web Apps, build and start the local server:

pnpm run preview:azure
# or
# npm run preview:azure

This script builds the project and starts the local server, mimicking the production environment with Azure Functions.

Type Checking

To perform TypeScript type checking, run:

pnpm type-check
# or
# npm run type-check

Linting and Formatting

Lint your code using ESLint and format it with Prettier:

pnpm lint
# or
# npm run lint

pnpm format
# or
# npm run format

Adjust the commands according to your preferred package manager (pnpm or npm).

Contributing

Thank you for considering contributing to the project! Whether it's reporting a bug, submitting a feature request, or contributing code, your help is appreciated.

Bug Reports

If you find a bug in the project, please open an issue on the issue tracker with a title and clear description of the problem. Provide any relevant details, such as error messages or screenshots, to help us understand and resolve the issue.

Feature Requests

If you have a feature idea or enhancement you'd like to see, feel free to open an issue on the issue tracker with the "Feature Request" label. Describe the new feature and explain why it would be beneficial.

Pull Requests

If you'd like to contribute code to the project, you can do so by following these steps:

1. Fork the project repository.
2. Create a new branch for your feature or bug fix: git checkout -b feature-name.
3. Make your changes and commit them: git commit -m 'Description of changes'.
4. Push your changes to your fork: git push origin feature-name.
5. Open a pull request on the pull request page of the original repository.

Please make sure to follow the existing coding style and include relevant tests if applicable. Your contribution will be reviewed, and feedback will be provided before merging.

License

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

Credits

• Brawlapi for player icons, events, brawler info etc.
• Fontawesome for icons.
• Heroicons for icons.