Skip to content

README.md

Latest commit

 

History

History
79 lines (64 loc) · 2.51 KB

README.md

File metadata and controls

79 lines (64 loc) · 2.51 KB

DashHack - Hackathon monitoring dashboard

Bun Nuxt Vue.js Tailwind CSS MongoDB Docker

DashHack is modern web dashboard for hackathon organization team.
The main goal of DashHack is to monitor teams progress and activity during the event.
This feature is reached by integration with GitHub API to fetch data from repositories.

The project was initially created for AT&T Hackathon Brno 2025.
Over time, DashHack got more generic and currently, it can be used for any hackathon event.

🛠️ Stack

💻 Run Locally (Development)

  1. Set up .env file
  2. bun install
  3. bun run dev

💻 Run Locally with local DB (Development)

  1. Set up .env file for local DB (example)
MONGO_URI_LOCAL=mongodb://127.0.0.1:27017/dashhack_dev
url=http://localhost
discord=https://discord.com/invite/<code>
webPort=6464
  1. bun install
  2. docker compose --env-file .env -f docker-compose-dev.yml up
  3. Configure VScode for debugger (.vscode/launch.json)
{
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Debug Nuxt (Node)",
      "runtimeExecutable": "npm",
      "runtimeArgs": ["run", "dev"],
      "cwd": "${workspaceFolder}",
      "console": "integratedTerminal",
      "envFile": "${workspaceFolder}/.env",
      "skipFiles": [
        "<node_internals>/**"
      ]
    }
  ]
}
  1. Start debugging with VScode

🏗️ Build for Production

  1. docker compose --env-file .env up --build

📄 Attribution

Author: ArimDev (PetyXbron)
License: Apache License 2.0 (see LICENSE)
Credit in pages/index.vue : "© 2025 ArimDev".
NOTICE file must be retained in redistributions.