# viraljain7/hack-web3conf architecture

> Architecture diagram of the GitHub repository viraljain7/hack-web3conf, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-02-04). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/viraljain7/hack-web3conf
- Repository: https://github.com/viraljain7/hack-web3conf

## Overview

##### Main Components

a) User Interface Layer:
- Registration Portal
- Project Submission Interface
- Badge Management System
- Documentation Viewer

b) Authentication System:
- Google OAuth
- GitHub OAuth
- Email Authentication

c) Core Services:
- Project Management Service
- Team Management Service
- Badge Distribution Service
- Documentation Service

d) External Integrations:
- GitHub API
- Social Media Links
- Video Platform Integration (Loom)

**[User Layer]**

- ▼
**[Authentication Layer]**

- ▼
**[Core Services Layer]**

- ▼
**[External Services Layer]**

##### Component Relationships
- User flow from registration to project submission
- Data flow between services
- Integration points with external services
- Badge distribution workflow

- User → Registration → Team Formation → Project Details → Submission
- Achievement Trigger → Badge Service → Profile Update → GitHub Profile Integration

##### Key Features to Highlight
- Multi-authentication support
- Team collaboration system
- Project submission workflow
- Badge management and distribution
- Documentation access points

##### Implementation Notes
- Keep the documentation system separate but connected
- Clear boundaries between user spaces and admin areas
- Points of extensibility for future features
- Security checkpoints in the flow

Remember to include:
- Clear entry points for different user types (participants, admins)
- Integration points with GSSoC platform
- Badge distribution mechanism
- Support and communication channels
- Data validation checkpoints

This system design should reflect the project's focus on providing a seamless experience for hackathon participants while maintaining robust backend services for project management and badge distribution.

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef user fill:#2196F3,color:white
    classDef auth fill:#4CAF50,color:white
    classDef core fill:#FF9800,color:white
    classDef external fill:#9C27B0,color:white
    classDef storage fill:#757575,color:white
    classDef docs fill:#03A9F4,color:white

    %% User Layer
    subgraph UserInterface
        UI1[Registration Portal]:::user
        UI2[Project Submission Interface]:::user
        UI3[Badge Management System]:::user
        UI4[Documentation Viewer]:::user
    end

    %% Authentication Layer
    subgraph Authentication
        Auth1[Google OAuth]:::auth
        Auth2[GitHub OAuth]:::auth
        Auth3[Email Authentication]:::auth
    end

    %% Core Services Layer
    subgraph CoreServices
        CS1[Project Management]:::core
        CS2[Team Management]:::core
        CS3[Badge Distribution]:::core
        CS4[Documentation Service]:::core
    end

    %% External Services Layer
    subgraph ExternalServices
        ES1[GitHub API]:::external
        ES2[Social Media]:::external
        ES3[Loom Integration]:::external
    end

    %% Relationships
    UI1 --> Auth1 & Auth2 & Auth3
    UI2 --> CS1
    UI3 --> CS3
    UI4 --> CS4

    Auth1 & Auth2 & Auth3 --> CS1
    CS1 --> CS2
    CS2 --> CS3
    CS3 --> ES1
    CS4 --> ES1

    %% Click Events
    click UI2 "https://github.com/viraljain7/Hack-Web3Conf/tree/main/Submit"
    click UI4 "https://github.com/viraljain7/Hack-Web3Conf/blob/main/README.md"
    click CS4 "https://github.com/viraljain7/Hack-Web3Conf/tree/main/assets"

    %% Legend
    subgraph Legend
        L1[User Interface]:::user
        L2[Authentication]:::auth
        L3[Core Services]:::core
        L4[External Services]:::external
    end
```
