Skip to main content

INSTALLATION

Installation & Usage Guide

Quick Start

# 1. Navigate to dashboard directory
cd /Volumes/AgentPlatform/wikis/blueflyio/technical-docs.wiki/tools/status-dashboard

# 2. Run setup script
./setup.sh

# 3. Configure GitLab token
echo "GITLAB_TOKEN=your_gitlab_token_here" > .env

# 4. Generate dashboard
npm run generate

Detailed Installation

Prerequisites

  • Node.js 18+ and npm
  • GitLab personal access token with read_api scope
  • Access to BlueFly.io GitLab group

Step 1: Install Dependencies

cd /Volumes/AgentPlatform/wikis/blueflyio/technical-docs.wiki/tools/status-dashboard
npm install

Step 2: Configure Environment

Create .env file:

cp .env.example .env

Edit .env with your GitLab token.

Step 3: Test Installation

npm run status

Usage Examples

Generate Complete Dashboard

npm run generate

Run Continuous Scheduler

npm run schedule

Troubleshooting

See README.md for detailed troubleshooting guide.

File Structure

status-dashboard/
├── src/
│   ├── types.ts                 # Type definitions
│   ├── collect-gitlab-data.ts   # Data collector
│   ├── calculate-health.ts      # Health calculator
│   ├── generate-dashboard.ts    # Dashboard generator
│   ├── cli.ts                   # CLI interface
│   └── scheduler.ts             # Automated scheduler
├── package.json
├── tsconfig.json
├── README.md
└── INSTALLATION.md             # This file