EdgeFlow Documentation

Web-based Framework for Developers

EdgeFlow is an open-source, web-based integrated development environment (IDE) and deployment platform designed for modern developers. It provides a comprehensive suite of tools for coding, collaboration, file management, and deployment—all accessible through your browser.

Key Features

Monaco Code Editor

VS Code-powered editor with syntax highlighting, IntelliSense, and multi-language support.

Real-time Collaboration

Team chat, presence indicators, and collaborative editing capabilities.

One-Click Deployment

Deploy to multiple environments with CI/CD pipelines and rollback support.

System Monitoring

Real-time metrics, edge node status, and performance dashboards.

Installation

Requirements

PHP 8.1 or higher
Composer 2.x
Node.js 18.x or higher
MySQL 8.0 / PostgreSQL 13+ / SQLite 3

Step 1: Clone the Repository

git clone https://github.com/edgeflow/edgeflow.git
cd edgeflow

Step 2: Install Dependencies

composer install
npm install

Step 3: Environment Setup

cp .env.example .env
php artisan key:generate

Step 4: Database Setup

# Configure your database in .env file
php artisan migrate --seed

Step 5: Build Assets & Run

npm run build
php artisan serve

✓ Success! Visit http://localhost:8000 to access EdgeFlow.

Quick Start

1

Create an Account

Register for a new account or log in with existing credentials. Email verification is required for security.

2

Explore the Dashboard

View your edge nodes, system metrics, and quick actions from the central dashboard.

3

Create Your First Project

Navigate to Files, create a new project, and start adding files to your workspace.

4

Write Code in the IDE

Open the IDE to write, edit, and run code with the Monaco editor's powerful features.

5

Deploy Your Application

Use the Deployment module to push your code to development, staging, or production environments.

Dashboard

The Dashboard provides a centralized view of your EdgeFlow environment, including edge node status, system metrics, and quick actions.

Features

Edge Node Monitoring - View all connected edge nodes with real-time status indicators
System Metrics - CPU, memory, and network usage at a glance
Quick Actions - Deploy, sync, or manage nodes directly from the dashboard
Activity Feed - Recent deployments, file changes, and team activity

IDE & Code Editor

EdgeFlow includes a powerful web-based IDE powered by Monaco Editor—the same editor that powers VS Code.

Editor Features

Syntax Highlighting

Support for 50+ programming languages including JavaScript, Python, PHP, Go, and more.

IntelliSense

Smart code completion, parameter hints, and quick info on hover.

Code Execution

Run code directly in the browser with output displayed in the integrated terminal.

Snippets

Save and load code snippets for quick access to frequently used code.

Keyboard Shortcuts

Action	Shortcut
Save File	`Ctrl/Cmd + S`
Run Code	`Ctrl/Cmd + Enter`
Find	`Ctrl/Cmd + F`
Replace	`Ctrl/Cmd + H`
Command Palette	`Ctrl/Cmd + Shift + P`

File Management

Organize your projects and files with EdgeFlow's comprehensive file management system.

Capabilities

Projects - Organize files into projects with descriptions and favorites
File Operations - Upload, download, rename, move, and delete files
Version History - Track file changes with automatic versioning
Trash & Recovery - Soft delete with restore capability
Bulk Actions - Select multiple files for batch operations
File Preview - Preview images, PDFs, and text files inline

Collaboration

Work together with your team in real-time using EdgeFlow's collaboration features.

Team Chat

Real-time messaging with your team members, with message history and search.

Presence Indicators

See who's online and what they're working on in real-time.

Activity Feed

Track team activity including file changes, deployments, and more.

Notifications

Get notified about important events and mentions.

Deployment

Deploy your applications with confidence using EdgeFlow's deployment management system.

Environments

Development Staging Production

Features

One-Click Deploy - Deploy to any environment with a single click
CI/CD Pipelines - Automated build, test, and deploy workflows
Rollback Support - Instantly rollback to previous versions
Deployment Logs - Detailed logs for every deployment
Environment Variables - Manage secrets and configuration per environment

Plugins

Extend EdgeFlow's functionality with plugins from the marketplace or create your own.

Available Plugins

Security Scanner

Vulnerability detection

Performance

Code optimization

Analytics

Usage insights

Monitoring

Monitor your applications and infrastructure with real-time metrics and alerts.

Metrics Tracked

CPU

Processor usage

Memory

RAM utilization

Network

I/O throughput

Disk

Storage usage

API Overview

EdgeFlow provides a comprehensive RESTful API for programmatic access to all features.

Base URL

https://your-domain.com/api

Response Format

All API responses are returned in JSON format:

{
  "success": true,
  "data": { ... },
  "message": "Operation successful"
}

Authentication

EdgeFlow uses Laravel Sanctum for API authentication. You can use either session-based authentication or API tokens.

Using API Tokens

# Include token in Authorization header
Authorization: Bearer your-api-token

Session Authentication

For web applications, use the CSRF token with session cookies for authentication.

API Endpoints

GET /api/dashboard/edge-nodes

Retrieve all edge nodes with status

POST /api/ide/run

Execute code in the IDE

GET /api/files

List all files and folders

POST /api/deployment/deploy

Trigger a new deployment

GET /api/plugins

List available plugins

Tech Stack

Backend

Laravel 10 - PHP Framework
MySQL/PostgreSQL - Database
Laravel Sanctum - API Auth
Laravel Echo - WebSockets

Frontend

Tailwind CSS - Styling
Alpine.js - Interactivity
Monaco Editor - Code Editor
Vite - Build Tool

Database Schema

EdgeFlow uses a relational database with the following core tables:

Core Tables

• users - User accounts
• projects - Project containers
• files - File storage
• file_versions - Version history

Edge & Deployment

• edge_nodes - Edge node registry
• deployments - Deployment records
• environments - Deploy targets
• pipelines - CI/CD configs

Collaboration

• messages - Chat messages
• code_snippets - Saved snippets
• metrics - System metrics

Extensions

• plugins - Installed plugins
• deployment_logs - Deploy logs
• personal_access_tokens - API tokens

Security

EdgeFlow implements multiple layers of security to protect your data and applications.

Password Hashing

All passwords are hashed using bcrypt with secure salt rounds.

CSRF Protection

All forms include CSRF tokens to prevent cross-site request forgery.

Rate Limiting

API endpoints are rate-limited to prevent abuse and DDoS attacks.

Email Verification

Users must verify their email before accessing protected features.

EdgeFlow Documentation

Key Features

Monaco Code Editor

Real-time Collaboration

One-Click Deployment

System Monitoring

Installation

Requirements

Step 1: Clone the Repository

Step 2: Install Dependencies

Step 3: Environment Setup

Step 4: Database Setup

Step 5: Build Assets & Run

Quick Start

Create an Account

Explore the Dashboard

Create Your First Project

Write Code in the IDE

Deploy Your Application

Dashboard

Features

IDE & Code Editor

Editor Features

Syntax Highlighting

IntelliSense

Code Execution

Snippets

Keyboard Shortcuts

File Management

Capabilities

Collaboration

Team Chat

Presence Indicators

Activity Feed

Notifications

Deployment

Environments

Features

Plugins

Available Plugins

Security Scanner

Performance

Analytics

Monitoring

Metrics Tracked

API Overview

Response Format

Authentication

Using API Tokens

Session Authentication

API Endpoints

Tech Stack

Backend

Frontend

Database Schema

Core Tables

Edge & Deployment

Collaboration

Extensions

Security

Password Hashing

CSRF Protection

Rate Limiting

Email Verification

Getting Started

Core Features