608 lines
25 KiB
HTML
608 lines
25 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Quickstart Guide - VAPORA Platform Documentation</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="Comprehensive documentation for VAPORA, an intelligent development orchestration platform built entirely in Rust.">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="favicon.svg">
|
|
<link rel="shortcut icon" href="favicon.png">
|
|
<link rel="stylesheet" href="css/variables.css">
|
|
<link rel="stylesheet" href="css/general.css">
|
|
<link rel="stylesheet" href="css/chrome.css">
|
|
<link rel="stylesheet" href="css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" id="highlight-css" href="highlight.css">
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="tomorrow-night.css">
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
|
|
|
|
<!-- Provide site root and default themes to javascript -->
|
|
<script>
|
|
const path_to_root = "";
|
|
const default_light_theme = "light";
|
|
const default_dark_theme = "dark";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="mdbook-help-container">
|
|
<div id="mdbook-help-popup">
|
|
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
|
<div>
|
|
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
|
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
|
<p>Press <kbd>?</kbd> to show this help</p>
|
|
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="body-container">
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
let theme = localStorage.getItem('mdbook-theme');
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
|
let theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
const html = document.documentElement;
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add("js");
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
let sidebar = null;
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<!-- populated by js -->
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
|
<noscript>
|
|
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
|
|
</noscript>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">VAPORA Platform Documentation</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
<a href="https://github.com/vapora-platform/vapora" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
<a href="https://github.com/vapora-platform/vapora/edit/main/docs/src/../quickstart.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<hr />
|
|
<h2>title: Vapora Project - Quick Start Guide
|
|
date: 2025-11-10
|
|
status: READY
|
|
version: 1.0</h2>
|
|
<h1 id="-vapora---quick-start-guide"><a class="header" href="#-vapora---quick-start-guide">🚀 Vapora - Quick Start Guide</a></h1>
|
|
<p><strong>⏱️ Time to get running: 15-20 minutes</strong></p>
|
|
<p>This guide walks you through building and running the complete Vapora project in the simplest way possible.</p>
|
|
<hr />
|
|
<h2 id="-prerequisites"><a class="header" href="#-prerequisites">📋 Prerequisites</a></h2>
|
|
<p>You need:</p>
|
|
<ul>
|
|
<li>✅ Rust 1.75+ (install from https://rustup.rs)</li>
|
|
<li>✅ Cargo (comes with Rust)</li>
|
|
<li>✅ Git</li>
|
|
<li>✅ NuShell 0.95+ (for scripts)</li>
|
|
<li>✅ 2GB free disk space</li>
|
|
<li>✅ Bash or Zsh shell</li>
|
|
</ul>
|
|
<p><strong>Check if you have everything:</strong></p>
|
|
<pre><code class="language-bash">rustc --version # Should show Rust 1.75+
|
|
cargo --version # Should show Cargo 1.75+
|
|
which git # Should show /usr/bin/git or similar
|
|
nu --version # Should show NuShell 0.95+
|
|
</code></pre>
|
|
<p><strong>Install NuShell if needed:</strong></p>
|
|
<pre><code class="language-bash"># Using Homebrew (macOS)
|
|
brew install nu
|
|
|
|
# Or download from: https://www.nushell.sh/
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="-15-minute-quick-start"><a class="header" href="#-15-minute-quick-start">🎯 15-Minute Quick Start</a></h2>
|
|
<h3 id="step-1-navigate-to-vapora"><a class="header" href="#step-1-navigate-to-vapora">Step 1: Navigate to Vapora</a></h3>
|
|
<pre><code class="language-bash"># Verify structure
|
|
ls crates/
|
|
# Should show: vapora-backend, vapora-frontend, vapora-shared, vapora-agents, vapora-llm-router, vapora-mcp-server, vapora-tracking
|
|
</code></pre>
|
|
<h3 id="step-2-install-dependencies"><a class="header" href="#step-2-install-dependencies">Step 2: Install Dependencies</a></h3>
|
|
<pre><code class="language-bash"># Update Rust (optional but recommended)
|
|
rustup update stable
|
|
|
|
# Install workspace dependencies
|
|
cargo fetch
|
|
</code></pre>
|
|
<h3 id="step-3-build-all-crates"><a class="header" href="#step-3-build-all-crates">Step 3: Build All Crates</a></h3>
|
|
<pre><code class="language-bash"># Build the complete workspace
|
|
cargo build
|
|
|
|
# This builds all 7 crates:
|
|
# - vapora-shared (shared utilities)
|
|
# - vapora-agents (agent framework)
|
|
# - vapora-llm-router (LLM routing)
|
|
# - vapora-tracking (change tracking system)
|
|
# - vapora-backend (REST API)
|
|
# - vapora-frontend (WASM UI)
|
|
# - vapora-mcp-server (MCP protocol support)
|
|
</code></pre>
|
|
<p><strong>Build time:</strong> 2-5 minutes (first time)</p>
|
|
<p><strong>Expected output:</strong></p>
|
|
<pre><code> Finished `dev` profile [unoptimized + debuginfo] target(s) in XXXs
|
|
</code></pre>
|
|
<h3 id="step-4-run-tests"><a class="header" href="#step-4-run-tests">Step 4: Run Tests</a></h3>
|
|
<pre><code class="language-bash"># Run all tests in the workspace
|
|
cargo test --lib
|
|
|
|
# Run tests for specific crate
|
|
cargo test -p vapora-backend --lib
|
|
cargo test -p vapora-tracking --lib
|
|
|
|
# Expected output:
|
|
# test result: ok. XXX passed; 0 failed
|
|
</code></pre>
|
|
<h3 id="step-5-start-the-backend-service"><a class="header" href="#step-5-start-the-backend-service">Step 5: Start the Backend Service</a></h3>
|
|
<pre><code class="language-bash"># Run the backend server (development mode)
|
|
cargo run -p vapora-backend
|
|
|
|
# Expected output:
|
|
# 🚀 Vapora Backend Server running on http://127.0.0.1:3000
|
|
# Available endpoints:
|
|
# GET /api/v1/health
|
|
# GET /api/v1/tracking/summary
|
|
# POST /api/v1/agents/orchestrate
|
|
# GET /api/v1/projects
|
|
</code></pre>
|
|
<p><strong>The server will be available at:</strong> <code>http://localhost:3000</code></p>
|
|
<h3 id="step-6-in-another-terminal-start-frontend-development"><a class="header" href="#step-6-in-another-terminal-start-frontend-development">Step 6: (In Another Terminal) Start Frontend Development</a></h3>
|
|
<pre><code class="language-bash">cd crates/vapora-frontend
|
|
|
|
# Install frontend dependencies
|
|
cargo install trunk
|
|
|
|
# Run frontend with hot-reload
|
|
trunk serve
|
|
|
|
# Expected output:
|
|
# 🦕 Listening on http://127.0.0.1:8080
|
|
</code></pre>
|
|
<p><strong>The UI will be available at:</strong> <code>http://localhost:8080</code></p>
|
|
<h3 id="step-7-verify-everything-works"><a class="header" href="#step-7-verify-everything-works">Step 7: Verify Everything Works</a></h3>
|
|
<pre><code class="language-bash"># Check health of backend
|
|
curl http://localhost:3000/api/v1/health
|
|
|
|
# Expected response:
|
|
# {
|
|
# "status": "ok",
|
|
# "service": "vapora-backend",
|
|
# "timestamp": "2025-11-10T14:30:00Z"
|
|
# }
|
|
|
|
# Check tracking system
|
|
curl http://localhost:3000/api/v1/tracking/summary
|
|
|
|
# Expected response:
|
|
# {
|
|
# "total_entries": 0,
|
|
# "changes": 0,
|
|
# "todos": 0
|
|
# }
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="-project-structure-overview"><a class="header" href="#-project-structure-overview">🏗️ Project Structure Overview</a></h2>
|
|
<pre><code>├── Cargo.toml (workspace config)
|
|
├── crates/
|
|
│ ├── vapora-shared/ ← Shared utilities & types
|
|
│ ├── vapora-agents/ ← Agent orchestration framework
|
|
│ ├── vapora-llm-router/ ← Multi-LLM routing (Claude, OpenAI, Gemini, Ollama)
|
|
│ ├── vapora-tracking/ ← Change & TODO tracking system (NEW)
|
|
│ ├── vapora-backend/ ← REST API (Axum)
|
|
│ ├── vapora-frontend/ ← Web UI (Leptos + WASM)
|
|
│ └── vapora-mcp-server/ ← MCP protocol server
|
|
├── scripts/
|
|
│ ├── sync-tracking.nu ← Sync tracking data
|
|
│ ├── export-tracking.nu ← Export reports
|
|
│ └── start-tracking-service.nu ← Start tracking service
|
|
└── docs/
|
|
└── (API docs, architecture, etc.)
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="-available-commands"><a class="header" href="#-available-commands">📊 Available Commands</a></h2>
|
|
<h3 id="build-commands"><a class="header" href="#build-commands">Build Commands</a></h3>
|
|
<pre><code class="language-bash"># Build specific crate
|
|
cargo build -p vapora-backend
|
|
cargo build -p vapora-tracking
|
|
|
|
# Build for production (optimized)
|
|
cargo build --release
|
|
|
|
# Check without building
|
|
cargo check
|
|
|
|
# Clean build artifacts
|
|
cargo clean
|
|
</code></pre>
|
|
<h3 id="test-commands"><a class="header" href="#test-commands">Test Commands</a></h3>
|
|
<pre><code class="language-bash"># Run all tests
|
|
cargo test --lib
|
|
|
|
# Run tests for specific crate
|
|
cargo test -p vapora-tracking --lib
|
|
|
|
# Run tests with output
|
|
cargo test -- --nocapture
|
|
|
|
# Run specific test
|
|
cargo test -p vapora-backend test_health_endpoint -- --exact
|
|
</code></pre>
|
|
<h3 id="development-commands"><a class="header" href="#development-commands">Development Commands</a></h3>
|
|
<pre><code class="language-bash"># Run backend server
|
|
cargo run -p vapora-backend
|
|
|
|
# Run with verbose logging
|
|
RUST_LOG=debug cargo run -p vapora-backend
|
|
|
|
# Format code
|
|
cargo fmt
|
|
|
|
# Lint code
|
|
cargo clippy -- -W clippy::all
|
|
</code></pre>
|
|
<h3 id="documentation"><a class="header" href="#documentation">Documentation</a></h3>
|
|
<pre><code class="language-bash"># Generate and open documentation
|
|
cargo doc -p vapora-backend --open
|
|
|
|
# Generate for specific crate
|
|
cargo doc -p vapora-tracking --open
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="-what-you-can-do-now"><a class="header" href="#-what-you-can-do-now">🎯 What You Can Do Now</a></h2>
|
|
<p>After the quick start, you have:</p>
|
|
<p>✅ <strong>Backend API running</strong> at <code>http://localhost:3000</code></p>
|
|
<ul>
|
|
<li>Health checks</li>
|
|
<li>Tracking system endpoints</li>
|
|
<li>Agent orchestration API</li>
|
|
</ul>
|
|
<p>✅ <strong>Frontend UI running</strong> at <code>http://localhost:8080</code></p>
|
|
<ul>
|
|
<li>Real-time project dashboard</li>
|
|
<li>Agent status monitoring</li>
|
|
<li>Change tracking interface</li>
|
|
</ul>
|
|
<p>✅ <strong>Tracking System</strong></p>
|
|
<ul>
|
|
<li>Log changes: <code>/log-change "description"</code></li>
|
|
<li>Create TODOs: <code>/add-todo "task"</code></li>
|
|
<li>Check status: <code>/track-status</code></li>
|
|
<li>Export reports: <code>./scripts/export-tracking.nu</code></li>
|
|
</ul>
|
|
<p>✅ <strong>Agent Framework</strong></p>
|
|
<ul>
|
|
<li>Orchestrate AI agents</li>
|
|
<li>Multi-LLM routing</li>
|
|
<li>Parallel pipeline execution</li>
|
|
</ul>
|
|
<hr />
|
|
<h2 id="-integration-points"><a class="header" href="#-integration-points">🔗 Integration Points</a></h2>
|
|
<h3 id="using-the-tracking-system"><a class="header" href="#using-the-tracking-system">Using the Tracking System</a></h3>
|
|
<p>The tracking system integrates with the backend:</p>
|
|
<pre><code class="language-bash"># Log a change
|
|
/log-change "Implemented user authentication" \
|
|
--impact backend \
|
|
--files 5
|
|
|
|
# Create a TODO
|
|
/add-todo "Review code changes" \
|
|
--priority H \
|
|
--estimate M
|
|
|
|
# Check tracking status
|
|
/track-status --limit 10
|
|
|
|
# Export to report
|
|
./scripts/export-tracking.nu json --output report.json
|
|
</code></pre>
|
|
<h3 id="using-the-agent-framework"><a class="header" href="#using-the-agent-framework">Using the Agent Framework</a></h3>
|
|
<pre><code class="language-bash"># Orchestrate agents for a task
|
|
curl -X POST http://localhost:3000/api/v1/agents/orchestrate \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"task": "Code review",
|
|
"agents": ["developer", "reviewer"],
|
|
"context": "Review the authentication module"
|
|
}'
|
|
</code></pre>
|
|
<h3 id="using-the-llm-router"><a class="header" href="#using-the-llm-router">Using the LLM Router</a></h3>
|
|
<pre><code class="language-bash"># Query the LLM router for optimal model selection
|
|
curl http://localhost:3000/api/v1/llm-router/select \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"task_type": "code_implementation",
|
|
"complexity": "high"
|
|
}'
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="-troubleshooting"><a class="header" href="#-troubleshooting">🐛 Troubleshooting</a></h2>
|
|
<h3 id="build-fails"><a class="header" href="#build-fails">Build Fails</a></h3>
|
|
<pre><code class="language-bash"># Update Rust
|
|
rustup update stable
|
|
|
|
# Clean and rebuild
|
|
cargo clean
|
|
cargo build
|
|
|
|
# Check specific error
|
|
cargo build --verbose
|
|
</code></pre>
|
|
<h3 id="tests-fail"><a class="header" href="#tests-fail">Tests Fail</a></h3>
|
|
<pre><code class="language-bash"># Run with output
|
|
cargo test --lib -- --nocapture --test-threads=1
|
|
|
|
# Check Rust version
|
|
rustc --version # Should be 1.75+
|
|
</code></pre>
|
|
<h3 id="backend-wont-start"><a class="header" href="#backend-wont-start">Backend Won't Start</a></h3>
|
|
<pre><code class="language-bash"># Check if port 3000 is in use
|
|
lsof -i :3000
|
|
|
|
# Use different port
|
|
VAPORA_PORT=3001 cargo run -p vapora-backend
|
|
|
|
# Check logs
|
|
RUST_LOG=debug cargo run -p vapora-backend
|
|
</code></pre>
|
|
<h3 id="frontend-build-issues"><a class="header" href="#frontend-build-issues">Frontend Build Issues</a></h3>
|
|
<pre><code class="language-bash"># Update trunk
|
|
cargo install --locked trunk
|
|
|
|
# Clear build cache
|
|
rm -rf crates/vapora-frontend/target
|
|
|
|
# Rebuild
|
|
cargo run -p vapora-frontend
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="-next-steps"><a class="header" href="#-next-steps">📚 Next Steps</a></h2>
|
|
<h3 id="short-term-this-session"><a class="header" href="#short-term-this-session">Short Term (This Session)</a></h3>
|
|
<ol>
|
|
<li>✅ Build and run the complete project</li>
|
|
<li>✅ Visit frontend at <code>http://localhost:8080</code></li>
|
|
<li>✅ Test API endpoints</li>
|
|
<li>✅ Create first tracking entry</li>
|
|
</ol>
|
|
<h3 id="medium-term-this-week"><a class="header" href="#medium-term-this-week">Medium Term (This Week)</a></h3>
|
|
<ol>
|
|
<li>Read <a href="./SETUP.html"><code>SETUP.md</code></a> - Complete setup with configuration</li>
|
|
<li>Explore crate documentation: <code>cargo doc --open</code></li>
|
|
<li>Set up development environment</li>
|
|
<li>Configure tracking system</li>
|
|
</ol>
|
|
<h3 id="long-term-ongoing"><a class="header" href="#long-term-ongoing">Long Term (Ongoing)</a></h3>
|
|
<ol>
|
|
<li>Contribute to the project</li>
|
|
<li>Deploy to production (see <a href="./crates/vapora-tracking/INTEGRATION.html"><code>INTEGRATION.md</code></a>)</li>
|
|
<li>Customize agents and LLM routing</li>
|
|
<li>Integrate with external services</li>
|
|
</ol>
|
|
<hr />
|
|
<h2 id="-learning-resources"><a class="header" href="#-learning-resources">📖 Learning Resources</a></h2>
|
|
<div class="table-wrapper"><table><thead><tr><th>Resource</th><th>Location</th><th>Time</th></tr></thead><tbody>
|
|
<tr><td>Project README</td><td><a href="./README.html"><code>README.md</code></a></td><td>10 min</td></tr>
|
|
<tr><td>Complete Setup</td><td><a href="./SETUP.html"><code>SETUP.md</code></a></td><td>20 min</td></tr>
|
|
<tr><td>Tracking System</td><td><a href="./QUICKSTART_TRACKING.html"><code>QUICKSTART_TRACKING.md</code></a></td><td>10 min</td></tr>
|
|
<tr><td>Architecture</td><td><a href="./.coder/"><code>.coder/</code></a></td><td>30 min</td></tr>
|
|
<tr><td>Source Code</td><td><a href="./crates/"><code>crates/</code></a></td><td>varies</td></tr>
|
|
<tr><td>API Docs</td><td><code>cargo doc --open</code></td><td>varies</td></tr>
|
|
</tbody></table>
|
|
</div>
|
|
<hr />
|
|
<h2 id="-quick-reference"><a class="header" href="#-quick-reference">🎬 Quick Reference</a></h2>
|
|
<pre><code class="language-bash"># One-command build and test
|
|
cargo build && cargo test --lib
|
|
|
|
# Run backend in one terminal
|
|
cargo run -p vapora-backend
|
|
|
|
# Run frontend in another terminal
|
|
cd crates/vapora-frontend && trunk serve
|
|
|
|
# Check everything is working
|
|
curl http://localhost:3000/api/v1/health
|
|
|
|
# View logs
|
|
RUST_LOG=debug cargo run -p vapora-backend
|
|
|
|
# Format and lint all code
|
|
cargo fmt && cargo clippy --all -- -W clippy::all
|
|
</code></pre>
|
|
<hr />
|
|
<h2 id="-getting-help"><a class="header" href="#-getting-help">🆘 Getting Help</a></h2>
|
|
<p><strong>Issues during quick start?</strong></p>
|
|
<ol>
|
|
<li>Check <a href="./SETUP.html"><code>SETUP.md</code></a> - Troubleshooting section</li>
|
|
<li>Read crate-specific docs in <code>crates/*/README.md</code></li>
|
|
<li>Check inline code documentation: <code>cargo doc --open</code></li>
|
|
<li>Review <code>.coder/</code> documentation</li>
|
|
</ol>
|
|
<hr />
|
|
<h2 id="-success-checklist"><a class="header" href="#-success-checklist">✅ Success Checklist</a></h2>
|
|
<ul>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Rust 1.75+ installed</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Git repository available</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>cargo build</code> succeeds</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
<code>cargo test --lib</code> shows all tests passing</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Backend runs at <code>http://localhost:3000</code></li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Frontend runs at <code>http://localhost:8080</code></li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Health endpoint responds</li>
|
|
<li><input disabled="" type="checkbox"/>
|
|
Can create tracking entries</li>
|
|
</ul>
|
|
<p><strong>All checked? ✅ You're ready to develop with Vapora!</strong></p>
|
|
<hr />
|
|
<p><strong>For complete setup with configuration options:</strong> See <a href="./SETUP.html"><code>SETUP.md</code></a></p>
|
|
<p><strong>For tracking system specific guide:</strong> See <a href="./QUICKSTART_TRACKING.html"><code>QUICKSTART_TRACKING.md</code></a></p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../getting-started.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../setup/index.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="../getting-started.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../setup/index.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="elasticlunr.min.js"></script>
|
|
<script src="mark.min.js"></script>
|
|
<script src="searcher.js"></script>
|
|
|
|
<script src="clipboard.min.js"></script>
|
|
<script src="highlight.js"></script>
|
|
<script src="book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|