HackMatrix Official Documentation

Comprehensive Guide for Clients, Customers, and Students

1. Table of Contents

  1. Document Control
  2. Executive Summary
  3. Introduction
  4. Technical Architecture
  5. User Guide
  6. Maintenance and Support
  7. Future Roadmap (Optional)
  8. Appendix

2. Executive Summary

Overview of HackMatrix

Hackmatrix is an enhanced hackathon management platform developed by Theax Pvt Ltd. Hackmatrix is a modular, scalable platform for enterprises and organizations to automate hackathon events and benefit from real-time analytics without the overhead of manual event management and evaluation.

Hackmatrix enables organizations and enterprises to seamlessly conduct hackathon events, ensuring a smooth and enhanced environment. Competitive features include real-time GitHub integration for monitoring projects and delivering seamless evaluations. Hackmatrix is designed for all platform users, from admins to end users, ensuring every role is carefully and smoothly carried out while maintaining confidentiality, integrity, and availability.

Target Audience

  • Large Enterprises (e.g., Microsoft, Google, IBM) for internal innovation events.
  • Universities organizing student hackathons.
  • Hackathon Platforms (e.g., Devpost, HackerEarth) seeking evaluation tools.

Key Takeaways

  • GitHub Integration: On-platform GitHub integration allows participants to link repositories to registered events and push real-time updates.
  • Real-time Evaluation: Evaluators benefit from real-time performance reviews and quick updates on new pull requests or pushes.
  • Multi-event Support: Organizers can manage multiple events simultaneously with unique configurations for each.
  • Customized Events: Events, rounds, team size, criteria, timelines, and GitHub requirements can be customized per event.
  • Seamless Registration: Teams can be added via Excel for bulk data or manually.
  • Role-based Access: Controlled access for event admin, evaluator, and team member, with defined privileges and security.
  • Real-time Analytics: Evaluators receive real-time updates on code commits and pull requests for dynamic evaluation and better insights.
  • Evaluator Assignment: Assign individuals to the evaluator role for specific events.

3. Introduction

Project Background

Hackmatrix began as a manually customized hackathon platform. With newer versions, it has evolved into an all-in-one solution for creating and managing hackathon events of any size and complexity, with competitive features making it the only platform needed for enterprise and organizational hackathons.

Objectives

  • Automate onboarding and customization for organizations and enterprises.
  • Provide controlled, well-defined access controls within events.
  • Ease of role assignment based on access privileges.
  • Customizations for team size and bandwidth.
  • GitHub integration for seamless project management.
  • Real-time updates for evaluators on code commits.
  • Enable evaluators to assess code quality for enhanced judgment.
  • Log activity monitoring for admins during events.

Scope

  • Organization and enterprise onboarding.
  • Requirement gathering for customized hackathons (team size, event duration, etc.).
  • Role-based access for event admins, evaluators, and team members.
  • Event creation.
  • Team registration via Excel upload or manual entry.
  • Separate dashboards for event admins, evaluators, and team members.
  • Log activity monitoring for admins.
  • GitHub integration for events.

Audience

  • Customer: Manages event creation, customization, role assignment, and overall administration.

  • Admin: Assigned by the customer that is the one who organizes the event to manage specific event.

  • Evaluators: Judge events based on code insights from GitHub repositories, view commits and builds.

  • Team Members: Register for events, link GitHub repos, view commit history, and more.

4. Technical Architecture

Technology Stack

  • Frontend: React + Vite + Carbon Design System
  • Backend: Node.js + Express + JWT Auth
  • Database: MySQL (Sequelize ORM)
  • GitHub Integration: GitHub API, OAuth 2.0, Webhooks
  • Tools: Swagger (API docs), ExcelJS (team upload), Chart.js (analytics), Git CLI

API Endpoints

  • [To be updated]

Security Considerations

  • [To be updated]

Scalability and Performance

  • [To be updated]

5. User Guide

Overview

This section provides comprehensive step-by-step guidance for all user roles within HackMatrix. Each role interacts with the platform via different interfaces (URLs), and performs specific responsibilities in the hackathon lifecycle.

Getting Started

  • Accessing the Platform:

  • Logging In:

    • URL: https://hackmatrix.theax.in/login
    • This is the login page where you will be required to login before accessing the platform regardless of role.
    • Select from the dropdown your role and enter the access credentials provided to you by the event organizer.
    • If you are an organizer, use the credentials you used during onboarding to the platform.

5.1 Customer Portal

  • URL: https://hackmatrix.theax.in/c/customer
  • Primary Role: The organization/enterprise that will host the hackathon event and primary user who will be subscribing to the Hackmatrix services.

Actions

5.1.1 Register as a Customer
URL: https://hackmatrix.theax.in/register

  • If you are a new organization looking to host any hackathon events, this is where you have to begin.
  • Register yourself by filling out the details on the customer registration page.
  • Confirm the credentials entered and your account will be created.

5.1.2 Login as a Customer
URL: https://hackmatrix.theax.in/login

  • Once you register, you will be required to login to access your customer dashboard.
  • Choose the Role type as “Customer” and fill out the credentials you created during registration.
  • Once you enter correct credentials, you will be redirected to the customer dashboard.

5.1.3 The Customer Dashboard
URL: https://hackmatrix.theax.in/customer

  • The central dashboard where the organization/enterprise hosting the events will manage the hackathon.
  • This dashboard is for all purposes from creating the events, managing to monitoring the same.

5.1.4 Create a new Hackathon event
URL: https://hackmatrix.theax.in/customer/hackreg

  • On the Customer dashboard, click on “create event” to navigate to the new event creation page.
  • Basic details:
    • Fill out the basic details to get started with the creation of a new hackathon event.
    • You will be asked for event name, type, duration, type of hackathon, tracks, etc.
    • The “Start Date and Time” is the duration of time the event is going to happen.
    • The time duration must exactly match the total durations selected above, even the “second” counts.
    • The “Registration start and end date” are the duration of time when the registration to the event will be live.
  • Location Details:
    • Update the location where you want to host your hackathon, including address, city, country, and state.
  • Organizer and contact information:
    • The details of the organizer of the hackathon you are hosting.
    • Update the details including official organization mail id, contact number, website, and social media links if any.
  • Judging Criteria:
    • Set up the judging criteria for your event.
    • You have the option to keep the “GitHub-based evaluation” for your event.
    • Choose the repository for the event from the linked GitHub account.
    • Later describe the judging criteria below.
  • Acknowledgement:
    • Acknowledge the event creation by agreeing to the terms and conditions on the page.
  • Confirmation of your event:
    • Once you acknowledge, you will get the Event confirmation page with the “link” to the hackathon preview page.
    • You can either copy the URL of the event or go to dashboard.
    • Share the URL of the event page with the participants.

5.1.5 Manage Your Events
URL: https://hackmatrix.theax.in/customer/table

  • Here you will be shown all the events hosted by you under your organization.
  • Under “hackathon events” section in your customer dashboard you can view all the events you created.
  • Click on view event of the event you want to view.
  • This will open the live page of the event where the users need to register for the event you hosted.
  • Manage your event by clicking on Manage.
  • Update/edit your event here.

5.1.5.1 View your live hosted event
URL: https://hackmatrix.theax.in/event/[event-ID]/

  • Here you can find the live page of your hosted event.
  • Participants will be seeing this page.
  • Participants and participating organizations in the hackathon will be viewing this page before registration.

5.1.5.2 Update/Edit event
URL: https://hackmatrix.theax.in/manage/event/[event-ID]/

  • Analytic dashboards Team management participants evaluators event settings reports & export
  • You can update or edit your hosted events here.
  • Analytics Dashboard to view insights of the selected event.
  • Team management section to manage teams for the selected event.
  • Manage the participants for the event.
  • Approve/reject teams and participants here.
  • View all evaluators for each round and each hackathon event.
  • Edit the details of the hackathon at Event Settings.
  • Reports and export to generate detailed report of the events.

5.1.6 Hackathon analytics

  • The place where you will be monitoring and tracking the activities of all the events you have hosted.

5.1.7 Management section

  • Team management: Manage the teams and members registered for the events you hosted.
  • Judge management: Assign the evaluators for events you hosted. Setup the evaluation criteria.
  • Sponsor Management: Manage the sponsors for the events.
  • Mentor Management: Manage mentors and their availability.
  • Submission Management: Review and evaluate the project submissions.

5.1.8 Github repository section

  • Connect the github repository you need to assign for your events.
  • Choose the connect account option.
  • Login to github from the login window.
  • Your github account will be linked.

5.1.9 Add Evaluator for your team
URL: https://hackmatrix.theax.in/evaluator-register

  • You can either click on your link above or navigate from manage event section to add evaluators for your event.
  • Add evaluator details and create a new evaluator profile including password which the evaluator will be using to login to their account where they can evaluate the assigned teams.
  • Confirm and create the profile.
  • Share the evaluator credentials with the respective evaluators.

5.2.0 Manage evaluators
URL: https://hackmatrix.theax.in/customer/manage/evaluators

  • Here you can manage all the evaluators you assigned for the respective hackathon events you created.
  • Manage the activity status of your evaluators.

5.2.1 Team assignments to Evaluators
URL: https://hackmatrix.theax.in/customer/teams

  • Here you can manage the team assignments to respective evaluators.
  • Respective evaluators can be assigned the specific teams.
  • Rounds they will be indulged in evaluating.
  • View the team assigned to various evaluators.

5.2.2 Manage Admins for your event
URL: https://hackmatrix.theax.in/customer/manage/admins

  • Manage all the admins for your respective events.
  • Assign events for your admins or manage admin actions.

5.2.3 Add Admin
URL: https://hackmatrix.theax.in/admin-register

  • Add the admin who will manage a specific event that you created.
  • Create their profile by creating username and password.
  • Share the created credentials with the respective admin user.

5.2.4 Problem statements curated for the hackathon events
URL: https://hackmatrix.theax.in/customer/challenges

  • Browse through our curated list of hackathon problem statements.

5.2 Admin Portal

  • URL: [To be updated]
  • Primary Role: [To be updated]
  • Actions: [To be updated]

5.3 Evaluator Panel

  • URL: https://hackmatrix.theax.in/evaluator
  • Primary Role: Evaluate the hackathon events and the specific teams, rounds for which they have been assigned.
  • Actions: Evaluate the assigned teams participating in a particular hackathon event. Access to github repository.

5.3.1 The Evaluated teams
URL: https://hackmatrix.theax.in/evaluator/teams

  • View all the teams you have evaluated including the scores allotted.

5.3.2 Problem Statements
URL: https://hackmatrix.theax.in/evaluator/challenges

  • Browse through our curated problem statements for hackathon event.

5.3.3 Evaluate based on rounds
URL: https://hackmatrix.theax.in/evaluator/eval/r1 URL: https://hackmatrix.theax.in/evaluator/eval/r2

  • Evaluate the teams based on rounds assigned.

5.4 Team Members

5.4.1 Register/Join a Team
URL: https://hackmatrix.theax.in/stu

  • Add team leader details. Team leader will be registering for the events hosted by the host. Enter the details of the team leader and team details.
  • Team details: Next is to add the team members details. Add up to 5 members including team leader.
  • Confirmation: Confirm the details of the team and submit.

6. Maintenance and Support

  • Troubleshooting Guide: [To be updated]
  • Change Management: [To be updated]
  • Contact and Support Information: [To be updated]

7. Future Roadmap (Optional)

  • Planned Features: [To be updated]
  • Improvement Areas: [To be updated]

8. Appendix

  • Glossary: [To be updated]
  • References: [To be updated]
  • Change Log: [To be updated]