Skip to content

esgi-insomniak/serezin-gaming-client

Repository files navigation

Serezin Gaming - Tournament Manager for League of Legends

Serezin Gaming

Welcome to Serezin Gaming, a platform designed to create and manage tournaments for League of Legends. This project streamlines the process of organizing competitive events, providing both front-end and back-end solutions.


Table of Contents

  1. Features
  2. Best Practices
  3. Git Hooks and Commit Guidelines
  4. Issues
  5. Contributing

Features

  • Tournament Creation: Create tournaments with customizable settings.
  • Player Management: Add and manage players and teams.
  • Match Scheduling: Creation of brackets and scheduling of matches.
  • Live Updates: Real-time match updates and scoreboards.
  • Admin Panel: Manage tournaments, players, and matches.
  • Live Streaming: Integration of live-streaming.
  • Leaderboards: Display rankings and statistics.
  • Predictions: Allow users to predict match outcomes, champion picks, etc.

Architecture

.
├── public -> public folder
├── src
│    ├── assets
│    ├── components
│    │      └── ui -> shadcn ui components
│    ├── docs -> all documentations
│    ├── libs
│    │   ├── api
│    │   │   ├── custom
│    │   │   ├── endpoints
│    │   │   ├── models
│    │   ├── stores
│    ├── pages
│    │   └── public-routes
│    ├── router
└────├── scripts
         └── all of the scritps

Installation

  1. Clone the repository:
git clone https://github.com/esgi-insomniak/serezin-gaming-client
  1. Install dependencies:
pnpm i
  1. Install mkcert for SSL support:
brew install mkcert

# in root folder
mkdir .infra
cd .infra
mkcert local.serezin-gaming.com
  1. Copy environment variables:
touch .env.development # if you don't have .env.development
touch .env.production # if you don't have .env.production
pnpm run copy:env
  1. (Not relevant to frontend project) Clone and install the Readme -> Serezin Gaming API
  2. Start the development server:
pnpm run dev

Contributing

We welcome contributions to the project! Please follow these steps:

  • Fork the repository.
  • Create a feature branch (feat/).
  • Commit changes using the Conventional Commits format.
  • Open a pull request with a detailed description of your changes.