{"id":21566756,"url":"https://github.com/lukewait/gc-esports-app2","last_synced_at":"2025-10-04T06:32:30.650Z","repository":{"id":250240473,"uuid":"833410796","full_name":"LukeWait/gc-esports-app2","owner":"LukeWait","description":"Provides a GUI interface to simplify the management of e-sports competition data stored on a database. This Java application was developed as part of a TAFE QLD assignment.","archived":false,"fork":false,"pushed_at":"2024-07-26T01:00:35.000Z","size":5186,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-18T05:31:57.476Z","etag":null,"topics":["competition-manager","csv-export","esports-management","gui","java","sql"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LukeWait.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-25T02:10:44.000Z","updated_at":"2024-07-26T01:02:58.000Z","dependencies_parsed_at":"2024-07-26T03:26:38.634Z","dependency_job_id":"a2eab85a-9002-4567-bf80-bbddd69ba914","html_url":"https://github.com/LukeWait/gc-esports-app2","commit_stats":null,"previous_names":["lukewait/gc-esports-app2"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/LukeWait/gc-esports-app2","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeWait%2Fgc-esports-app2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeWait%2Fgc-esports-app2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeWait%2Fgc-esports-app2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeWait%2Fgc-esports-app2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LukeWait","download_url":"https://codeload.github.com/LukeWait/gc-esports-app2/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LukeWait%2Fgc-esports-app2/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278277230,"owners_count":25960423,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-04T02:00:05.491Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["competition-manager","csv-export","esports-management","gui","java","sql"],"created_at":"2024-11-24T10:27:59.483Z","updated_at":"2025-10-04T06:32:30.634Z","avatar_url":"https://github.com/LukeWait.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gold Coast E-Sports Competition App 2\n## Description\nThis application helps manage competition data effectively using a user-friendly GUI. The app interacts with a SQL relational database to manage teams, matches, and results.\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/LukeWait/gc-esports-app2/raw/main/src/images/gc-esports-app2-screenshot.png\" alt=\"App Screenshot\" width=\"600\"\u003e\n\u003c/p\u003e\n\n## Table of Contents\n- [Installation](#installation)\n- [Usage](#usage)\n- [Development](#development)\n- [License](#license)\n- [Acknowledgments](#acknowledgments)\n- [Source Code](#source-code)\n- [Dependencies](#dependencies)\n\n## Installation\n### Prerequisites\nEnsure that Java JDK 17 is installed on your system:\n- **Windows**: Download and install [Java JDK 17](https://www.oracle.com/java/technologies/javase-jdk17-downloads.html).\n- **Linux**: Install Java JDK 17 using your package manager:\n  ```sh\n  sudo apt-get install openjdk-17-jdk   # For Debian-based systems\n  ```\n\n### Set Up MySQL Server\n- **Windows**:\n  1. Download the MySQL installer from the [MySQL Community Downloads page](https://dev.mysql.com/downloads/mysql/).\n  2. Run the installer and follow the prompts to complete the installation.\n  3. During installation, you can choose to run the MySQL Server as a Windows service. Otherwise you can start it manually from the Services app or by running:\n    ```sh\n    net start mysql\n    ```\n\n- **Linux**:\n  Download the package and run the service:\n  ```sh\n  sudo apt-get install mysql-server  # For Debian-based systems\n  sudo systemctl start mysql\n  sudo systemctl status mysql   # Check if the service is running\n  ```\n\n#### Import the Database\nOnce the SQL server is running, you can import the `gc_esports.sql` file to set up the database. Replace `username` (default: `root`) and `path/to/gc_esports.sql` with your MySQL username and the path to the SQL dump file:\n```sh\nmysql -u username -p \u003c path/to/gc_esports.sql\n```\n\n#### Configure the `db_access.config` File\nThe `db_access.config` file contains the connection string for the database service. It is currently set to use the default MySQL credentials running on localhost/127.0.0.1. Ensure these settings match your database credentials for proper application functionality.:\n```sh\ndbURL=jdbc:mysql://localhost:3306/gc_esports?serverTimezone=UTC\nusrID=root\nusrPWD=\n```\n\n#### Alternative SQL Server Options\nYou can opt for a web server solution like **XAMPP** or **WAMP** for ease of use. These solutions come with tools like phpMyAdmin, providing a GUI for importing and managing databases.\n- **XAMPP**: [Download XAMPP](https://www.apachefriends.org/index.html)\n- **WAMP**: [Download WAMP](http://www.wampserver.com/en/)\n\n### Executable\n1. Download the latest release from the [releases page](https://github.com/LukeWait/gc-esports-app2/releases).\n2. Extract the contents to a desired location.\n3. Run the `gc-esports-app2.jar` file:\n   - **Windows**: Simply double-click the `gc-esports-app2.jar` file to run it.\n   - **Linux**: Make the `.jar` file executable and run it:\n     ```sh\n     chmod +x gc-esports-app2.jar\n     java -jar gc-esports-app2.jar\n     ```\n\n### From Source\nTo install and run the application from source:\n1. Clone the repository:\n    ```sh\n    git clone https://github.com/LukeWait/gc-esports-app2.git\n    cd gc-esports-app2\n    ```\n2. Open the project directory with Apache NetBeans or another compatible IDE to build and run the application.\n\n## Usage\n1. Ensure the gc_esports database is running on an accessible server with the correct access details entered in `db_access.config`.\n2. Launch the application.\n3. Use the provided functions to interact with the data:\n   - Create and view competition and event data.\n   - Create, view, and update team data.\n   - Note: There is currently no option to delete data.\n\n### Application Functions\n- **Display Competition Results**: View results for all competitions, with the option to filter by event or team.\n- **Export Competition Results**: Export the displayed competition results as a CSV file.\n- **Display Leaderboard**: Show a leaderboard for the entire competition or a single event based on the selected filter.\n- **Export Leaderboard**: Export the currently displayed leaderboard as a CSV file.\n- **Add New Competition Results**: Input and save results for new competitions.\n- **Add New Team**: Register a new team along with their contact information.\n- **Update Existing Team**: Modify the details of an already registered team.\n- **Add New Event**: Create and save details for a new event within the competition.\n\n## Development\nThis project was developed using Apache NetBeans, an integrated development environment (IDE) that facilitates Java application development. If using a different IDE, you may need to configure the environment to ensure compatibility with the project.\n\n### Project Structure\n```sh\ngc-esports-app2/\n├── nbproject/                # NetBeans settings\n├── data/                     # CSV export files\n├── lib/                      # JAR libraries\n├── sql/                      # SQL database schema\n├── src/\n│   ├── images/               # GUI design elements\n│   └── gcesportsapp2/        # Project source code\n│       ├── GCEsportsApp2.java\n│       ├── GCEsportsApp2.form\n│       ├── DbRead.java\n│       └── DbWrite.java\n├── build.xml                 # Build configuration\n├── manifest.mf               # Manifest file for the JAR\n└── db_access.config          # Database connection details\n```\n\n### SQL Database Structure\n```\ngc_esports Database\n└── Tables:\n    ├── event\n    │   ├── name (PK)\n    │   ├── date\n    │   └── location\n    │\n    ├── game\n    │   ├── name (PK)\n    │   └── type\n    │\n    ├── team\n    │   ├── name (PK)\n    │   ├── contact\n    │   ├── phone\n    │   └── email\n    │\n    └── competition\n        ├── competitionID (PK)\n        ├── eventName (FK -\u003e event.name)\n        ├── gameName (FK -\u003e game.name)\n        ├── team1 (FK -\u003e team.name)\n        ├── team2 (FK -\u003e team.name)\n        ├── team1Points\n        └── team2Points\n```\n\n### Creating New Releases\n- **Build the Application**: Use your IDE to compile and package the application into a `.jar` executable, which will create a `dist` folder containing the final distributable files.\n- **Create `data` Directory**: Create an empty directory called `data` in the `dist` folder for potential CSV exports.\n- **Include `db_access.config` File**: Copy the config file into the `dist` folder, as it is required to establish a database connection.\n- **Include `gc_access.sql` File**: You may want to include the SQL dump in the `dist` folder so users can re-create the database.\n\n## License\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n## Acknowledgments\nThis project was developed as part of an assignment at TAFE Queensland for subject ICTPRG430.\n\nProject requirements and initial GUI design/codebase provided by Hans Telford.\n\n## Source Code\nThe source code for this project can be found in the GitHub repository: [https://github.com/LukeWait/gc-esports-app2](https://www.github.com/LukeWait/gc-esports-app2).\n\n## Dependencies\n- Java JDK 17\n- MySQL Connector/J 8.0.28 (included in project files)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukewait%2Fgc-esports-app2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flukewait%2Fgc-esports-app2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flukewait%2Fgc-esports-app2/lists"}