JS-Hub-ZW / hackathon-board

This is a hackathon board frontend which connects to urban-spoon(the backend)
MIT License
5 stars 5 forks source link
chrakaui hackathon hackathon-project hacktoberfest javascript react zimbabwe

Hackathon Board 👨‍💻

A site where people can post hackathons and register hackathons

Stack

Users

  1. The hackers
  2. Hosters
  3. Admins
  4. Guests

User Roles

The Hackers

The Hosters

Admins

Guests

Other functionalities

Stories

Stage 1: Add a hackathon

sequenceDiagram
    participant Hoster 🌐
    participant Admin 👑
    participant Hacker 👨‍💻
      Hoster 🌐->>Admin 👑: Here is a new hackathon?
      alt approve hackathon
          Admin 👑->>Hoster 🌐: Yay your hackthon is valid!
          Admin 👑-->>Hacker 👨‍💻: We got a hackathon!
      else decline hackathon
        Admin 👑->>Hoster 🌐: Your hackathon is not valid
      end
  1. Hoster registers or signs up
  2. They add a hackerthon and submit it
  3. The admin reviews and approves
  4. A message gets broadcasted to all subscribed members
  5. The hackthon is displayed on the board Stage 4 and 5 can be done in parallel to speed things up

Stage 2: Registering for a hackthon

sequenceDiagram
    participant Hoster 🌐
    participant System 🖥️
    participant Hacker 👨‍💻
      Hacker 👨‍💻->>+System 🖥️:Here are my creds
      System 🖥️->>-Hacker 👨‍💻: Cool, your are in
      Hacker 👨‍💻->>Hoster 🌐: 🥺 Hey, I want to participate
  1. Hacker registers or signs up
  2. They click a hackthon and add their details
  3. And click submit

Note that a hackar can register as an individual or register as a team. If they register as a team they must have a team leader to do the registration. A check is made to see if they have not applied yet

Stage 3: Approving requests

sequenceDiagram
    participant Hoster 🌐
    participant System 🖥️
    participant Hacker 👨‍💻

      activate Hoster 🌐
      alt approve hacker
          Hoster 🌐->>Hacker 👨‍💻: ✅ Cool
      else decline hacker
          Hoster 🌐->>Hacker 👨‍💻: ❌ Nop you cant

      end
      deactivate Hoster 🌐
      System 🖥️-->>Hacker 👨‍💻: ✉️ You got approved/declined
  1. Hoster can see all applicants
  2. They can approve and delete applications
  3. A message is sent

Stage 3 and 2 are done in parralel

Relationships