Skip to content

Latest commit

 

History

History
56 lines (38 loc) · 2.09 KB

README.md

File metadata and controls

56 lines (38 loc) · 2.09 KB

Helwan Tournaments

Helwan Tournaments is a web platform designed to facilitate competitive gaming events, specifically tailored for titles like Valorant. It allows users to register, participate in tournaments, schedule matches, and track their performance. With robust security measures and MySQL database integration, the platform offers a secure and seamless experience for players, teams, and organizers.

Features

  • User registration and authentication
  • Tournament creation and management
  • Match scheduling and tracking
  • Team creation and management
  • Comprehensive user profiles
  • Real-time notifications and updates

Technologies Used

  • Backend: Java Spring Boot
  • Frontend: React.js
  • Database: MySQL
  • Authentication: JSON Web Tokens (JWT)

Getting Started

To run the Helwan Tournaments platform locally, follow these steps:

  1. Clone this repository to your local machine.
  2. Navigate to the backend directory and run mvn spring-boot:run to start the backend server.
  3. Navigate to the frontend directory and run npm install followed by npm start to start the frontend server.
  4. Access the platform via http://localhost:3000 in your web browser.

Getting Started with Docker

To run the Helwan Tournaments platform locally using Docker, follow these steps:

  1. Clone this repository to your local machine.
  2. Navigate to the root directory of the project where the docker-compose.yml file is located.
  3. Run the following command to start the Docker containers:
docker-compose up

Contributing

We welcome contributions from the community to improve and enhance the Helwan Tournaments platform. If you'd like to contribute, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and ensure they adhere to the project's coding style and conventions.
  4. Test your changes thoroughly.
  5. Commit your changes and push them to your fork.
  6. Submit a pull request detailing the changes you've made.

License

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