Sanity Esports

Sanity Esports is an open-source platform designed to host and manage gaming tournaments. It provides a seamless experience for organizers, players, and viewers, ensuring efficient management and high engagement. This repository contains the source code, documentation, and resources necessary to run your own esports tournaments.

Features
Getting Started
Installation
Usage
Configuration
Contributing
License
Contact

Features

Tournament Management: Create, manage, and track various types of gaming tournaments.
User Registration: Allow users to register and participate in tournaments.
Bracket Generation: Automatic generation of tournament brackets and match scheduling.
Live Updates: Real-time updates of match results and leaderboards.
Notifications: Email and in-app notifications for important events and updates.
Analytics: Insights and analytics for tournament performance and user engagement.
Customizable: Flexible settings to customize tournament rules, formats, and visuals.

Getting Started

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

Prerequisites

Next.js
Node.js (v14.x or higher)
npm
MongoDB

Installation

Clone the repository:

git clone https://github.com/dinxsh/sanity.git
cd sanity

Install NPM packages:
```
npm install
```
Set up your environment variables:

Create a .env file in the root directory and add the following variables:
```
 DATABASE_URL=
 MONGODB_URL=
 RESEND_API_KEY=
 NEXTAUTH_SECRET=
```

Running the Application

Start the development server:
```
npm start
```
Open your browser and navigate to:
```
http://localhost:3000
```

Usage

Creating a Tournament

Log in as an organiser.
Navigate to the "Create Tournament" page.
Fill in the tournament details, such as name, game, format, and rules.
Click "Create" to publish the tournament.

Registering for a Tournament

Log in to your account.
Browse the available tournaments.
Select a tournament and click "Register."
Follow the on-screen instructions to complete your registration.

Configuration

Customization

To customize the application, modify the following files:

Frontend: src/components/ and src/styles/
Backend: src/api/ and src/auth/

Refer to the documentation for detailed customization instructions.

Contributing

We welcome contributions from the community! To get started, please read our Contributing Guide.

Fork the Repository

Fork the project on GitHub.

Clone your fork locally:

git clone https://github.com/dinxsh/sanity-esports.git
cd sanity-esports

Create a new branch for your feature or bug fix:
```
git checkout -b feature/your-feature-name
```

Commit your changes and push to GitHub:

git commit -m "Add your commit message here"
git push origin feature/your-feature-name

Create a pull request on the original repository.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Maintainer: Dinesh Talwadker - dineshtalwadker@gmail.com
GitHub Repository: Sanity Esports - Dinesh

Feel free to modify this template according to your project's specifics and needs. Adding screenshots, diagrams, and links to additional documentation can also enhance the README.

Abhish7k / sanity