# umsisamess/fourspace-client architecture

> Architecture diagram of the GitHub repository umsisamess/fourspace-client, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/umsisamess/fourspace-client
- Repository: https://github.com/umsisamess/fourspace-client

## Overview

##### Project type and purpose
- This is a pure frontend client (“FourSpace-Client”) for a coding-contest platform. It serves static HTML/CSS/JS pages that communicate with backend services (authentication, contests, questions, profiles).
- The purpose is to allow two user roles—job-seekers and companies—to sign up, log in, view/create contests, attempt questions, and view leaderboards.

##### File structure
- Top-level HTML pages (index.html, login.html, register.html, contests.html, contest.html, question.html, addContest.html, addquestion.html, leaderboard.html, profile.html).
- `/css/` directory holds per-page style files and a default.css.
- `/js/` directory holds per-page script files (e.g., contests.js, contest.js, question.js, addContest.js, addquestion.js, leaderboard.js, profile.js, register.js, login.js, default.js).
- No backend code here—implicit dependency on remote APIs.

##### README for additional insights
- Technology stack: HTML, CSS, JavaScript.
- Hosted on Netlify (static-site CDN).
- Uses RESTful calls to backend services for auth, contest management, question data, user profiles, and ratings/leaderboard.
- Future modules: Job listings service, interview platform, feedback form.

##### Main components
a. Clients
- Browser UI (the static site)
- Actors: Job-Seeker, Company
b. Frontend Application
- Static Hosting (Netlify/CDN)
- HTML pages + CSS + JS modules
- Central config/default.js for common logic (e.g., token storage)
c. Backend Services (external, not in this repo)
- Authentication Service (login, signup, token issuance)
- Contest Service (list contests, create contest, add questions)
- Question Service (serve question data, submit answers)
- Leaderboard/Rating Service (compute & serve leaderboards)
- User/Profile Service (fetch/update profiles & availability status)
d. Data Storage
- User database
- Contest database
- Question database
- Ratings database

##### Relationships and interactions
- Browser loads static assets from CDN.
- JS code orchestrates REST calls:
- Auth endpoints → receive JWT/token
- Contest endpoints → fetch/add contests
- Question endpoints → fetch questions, submit solutions
- Leaderboard endpoints → fetch ranking data
- Profile endpoints → fetch/update user metadata
- Responses drive dynamic DOM rendering.

##### Architectural patterns & principles
- Separation of concerns: each HTML page has paired JS and CSS modules.
- RESTful service integration: thin client, heavy lifting on backend.
- Stateless authentication via tokens stored in browser (e.g., localStorage).
- Modular frontend: default.js for common logic, page-specific scripts for feature logic.

##### Essential elements
- Arrowheads on every communication link with HTTP verbs (e.g., GET /contests)
- Notation of technology choices: “Netlify CDN”, “Fetch API in JavaScript”, “JWT auth”

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Actors
    subgraph "Actors"
        JS("Job-Seeker"):::actor
        CL("Company"):::actor
    end

    %% Browser
    subgraph "User Browser"
        Browser["Browser UI"]:::frontend
    end

    JS --> Browser
    CL --> Browser

    %% CDN
    Browser -->|"GET assets"| CDN["Static Hosting / CDN"]:::frontend

    %% Static Hosting Content
    subgraph "Static Hosting / CDN"
        direction TB

        subgraph "HTML Pages"
            direction TB
            addContestHTML["addContest.html"]:::frontend
            addQuestionHTML["addquestion.html"]:::frontend
            contestHTML["contest.html"]:::frontend
            contestsHTML["contests.html"]:::frontend
            indexHTML["index.html"]:::frontend
            leaderboardHTML["leaderboard.html"]:::frontend
            loginHTML["login.html"]:::frontend
            profileHTML["profile.html"]:::frontend
            questionHTML["question.html"]:::frontend
            registerHTML["register.html"]:::frontend
        end

        subgraph "CSS Modules"
            direction TB
            addContestCSS["css/addContest.css"]:::frontend
            addQuestionCSS["css/addquestion.css"]:::frontend
            contestCSS["css/contest.css"]:::frontend
            contestsCSS["css/contests.css"]:::frontend
            defaultCSS["css/default.css"]:::frontend
            indexCSS["css/index.css"]:::frontend
            leaderboardCSS["css/leaderboard.css"]:::frontend
            profileCSS["css/profile.css"]:::frontend
            questionCSS["css/question.css"]:::frontend
            registerCSS["css/register.css"]:::frontend
        end

        subgraph "JS Modules"
            direction TB
            defaultJS["js/default.js"]:::frontend
            addContestJS["js/addContest.js"]:::frontend
            addQuestionJS["js/addquestion.js"]:::frontend
            contestJS["js/contest.js"]:::frontend
            contestsJS["js/contests.js"]:::frontend
            loginJS["js/login.js"]:::frontend
            registerJS["js/register.js"]:::frontend
            questionJS["js/question.js"]:::frontend
            leaderboardJS["js/leaderboard.js"]:::frontend
            profileJS["js/profile.js"]:::frontend
        end

        assetsDir["assets/"]:::frontend
    end

    %% Backend Services
    subgraph "Backend Services"
        direction TB
        AuthSvc["Authentication Service API"]:::service
        ContestSvc["Contest Service API"]:::service
        QuestionSvc["Question Service API"]:::service
        LeaderboardSvc["Leaderboard Service API"]:::service
        ProfileSvc["User/Profile Service API"]:::service
    end

    %% Databases
    subgraph "Databases"
        direction TB
        UsersDB["Users DB"]:::database
        ContestsDB["Contests DB"]:::database
        QuestionsDB["Questions DB"]:::database
        RatingsDB["Ratings DB"]:::database
    end

    %% Interactions
    CDN -->|"fetch default.js (base URL, JWT config)"| defaultJS
    defaultJS -->|"calls GET /auth"| AuthSvc
    defaultJS -->|"calls GET /contests"| ContestSvc
    defaultJS -->|"calls GET /questions"| QuestionSvc
    defaultJS -->|"calls GET /leaderboard"| LeaderboardSvc
    defaultJS -->|"calls GET /profile"| ProfileSvc

    addContestJS -->|"POST /contests"| ContestSvc
    addQuestionJS -->|"POST /questions"| QuestionSvc
    contestJS -->|"GET /contest/:id"| ContestSvc
    contestsJS -->|"GET /contests"| ContestSvc
    questionJS -->|"POST /submit"| QuestionSvc
    leaderboardJS -->|"GET /leaderboard"| LeaderboardSvc
    profileJS -->|"PUT /profile"| ProfileSvc
    loginJS -->|"POST /login, POST /register"| AuthSvc
    registerJS -->|"POST /register"| AuthSvc

    AuthSvc -->|SQL| UsersDB
    ContestSvc -->|SQL| ContestsDB
    QuestionSvc -->|SQL| QuestionsDB
    LeaderboardSvc -->|SQL| RatingsDB
    ProfileSvc -->|SQL| UsersDB

    %% Click Events
    click addContestHTML "https://github.com/umsisamess/fourspace-client/blob/main/addContest.html"
    click addQuestionHTML "https://github.com/umsisamess/fourspace-client/blob/main/addquestion.html"
    click contestHTML "https://github.com/umsisamess/fourspace-client/blob/main/contest.html"
    click contestsHTML "https://github.com/umsisamess/fourspace-client/blob/main/contests.html"
    click indexHTML "https://github.com/umsisamess/fourspace-client/blob/main/index.html"
    click leaderboardHTML "https://github.com/umsisamess/fourspace-client/blob/main/leaderboard.html"
    click loginHTML "https://github.com/umsisamess/fourspace-client/blob/main/login.html"
    click profileHTML "https://github.com/umsisamess/fourspace-client/blob/main/profile.html"
    click questionHTML "https://github.com/umsisamess/fourspace-client/blob/main/question.html"
    click registerHTML "https://github.com/umsisamess/fourspace-client/blob/main/register.html"

    click addContestCSS "https://github.com/umsisamess/fourspace-client/blob/main/css/addContest.css"
    click addQuestionCSS "https://github.com/umsisamess/fourspace-client/blob/main/css/addquestion.css"
    click contestCSS "https://github.com/umsisamess/fourspace-client/blob/main/css/contest.css"
    click contestsCSS "https://github.com/umsisamess/fourspace-client/blob/main/css/contests.css"
    click defaultCSS "https://github.com/umsisamess/fourspace-client/blob/main/css/default.css"
    click indexCSS "https://github.com/umsisamess/fourspace-client/blob/main/css/index.css"
    click leaderboardCSS "https://github.com/umsisamess/fourspace-client/blob/main/css/leaderboard.css"
    click profileCSS "https://github.com/umsisamess/fourspace-client/blob/main/css/profile.css"
    click questionCSS "https://github.com/umsisamess/fourspace-client/blob/main/css/question.css"
    click registerCSS "https://github.com/umsisamess/fourspace-client/blob/main/css/register.css"

    click defaultJS "https://github.com/umsisamess/fourspace-client/blob/main/js/default.js"
    click addContestJS "https://github.com/umsisamess/fourspace-client/blob/main/js/addContest.js"
    click addQuestionJS "https://github.com/umsisamess/fourspace-client/blob/main/js/addquestion.js"
    click contestJS "https://github.com/umsisamess/fourspace-client/blob/main/js/contest.js"
    click contestsJS "https://github.com/umsisamess/fourspace-client/blob/main/js/contests.js"
    click loginJS "https://github.com/umsisamess/fourspace-client/blob/main/js/login.js"
    click registerJS "https://github.com/umsisamess/fourspace-client/blob/main/js/register.js"
    click questionJS "https://github.com/umsisamess/fourspace-client/blob/main/js/question.js"
    click leaderboardJS "https://github.com/umsisamess/fourspace-client/blob/main/js/leaderboard.js"
    click profileJS "https://github.com/umsisamess/fourspace-client/blob/main/js/profile.js"

    click assetsDir "https://github.com/umsisamess/fourspace-client/tree/main/assets/"

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0366d6,stroke-width:1px
    classDef service fill:#FFE0B2,stroke:#F57C00,stroke-width:1px
    classDef database fill:#C8E6C9,stroke:#388E3C,stroke-width:1px
    classDef actor fill:#F5F5F5,stroke:#9E9E9E,stroke-width:1px,stroke-dasharray: 2 2
```
