froggy-docs 1.0.0

package/frontend/web/styles.css

@@ -0,0 +1,405 @@
+/* လင်း/မှောင် (Light/Dark Theme) အရောင်များကို သတ်မှတ်ခြင်း */
+:root {
+  --bg-main: #ffffff;
+  --bg-sidebar: #f4f6f8;
+  --text-main: #333333;
+  --text-muted: #6c757d;
+  --border-color: #e0e0e0;
+  --primary-color: #2e7d32;
+  --code-bg: #f8f9fa;
+  --table-header: #f8f9fa;
+}
+
+[data-theme="dark"] {
+  --bg-main: #0d1117;
+  --bg-sidebar: #161b22;
+  --text-main: #c9d1d9;
+  --text-muted: #8b949e;
+  --border-color: #30363d;
+  --primary-color: #4CAF50;
+  --code-bg: #161b22;
+  --table-header: #21262d;
+}
+
+* {
+  box-sizing: border-box;
+}
+
+body {
+  margin: 0;
+  font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
+  display: flex;
+  height: 100vh;
+  overflow: hidden; /* အပြင်ဘက်ဆုံးကို Scroll မဆင်းစေဘဲ အတွင်းကိုပဲ Scroll ဆင်းစေရန် */
+  background-color: var(--bg-main);
+  color: var(--text-main);
+  transition: background-color 0.3s, color 0.3s;
+}
+
+.app-container {
+  display: flex;
+  height: 100vh;
+  width: 100%;
+  overflow: hidden;
+}
+
+/* ================== Sidebar Layout ================== */
+.sidebar {
+  width: 300px;
+  min-width: 300px;
+  background-color: var(--bg-sidebar);
+  border-right: 1px solid var(--border-color);
+  display: flex;
+  flex-direction: column;
+  height: 100vh;
+}
+
+.sidebar-header {
+  padding: 1.5rem 1.5rem 1rem;
+}
+
+.sidebar-header h2 {
+  margin: 0;
+  display: flex;
+  align-items: center;
+  gap: 10px;
+  font-size: 1.4rem;
+  color: var(--text-main);
+}
+
+.search-container {
+  padding: 0 1.5rem 1rem;
+}
+
+.search-box {
+  width: 100%;
+  padding: 0.6rem 1rem;
+  border: 1px solid var(--border-color);
+  border-radius: 6px;
+  background-color: var(--bg-main);
+  color: var(--text-main);
+  outline: none;
+  font-size: 0.95rem;
+}
+
+.search-box:focus {
+  border-color: var(--primary-color);
+}
+
+/* သီးခြား Scroll ဆင်းနိုင်သော Navigation List */
+.nav-list {
+  flex-grow: 1;
+  overflow-y: auto;
+  padding: 0 1rem 1rem;
+  display: flex;
+  flex-direction: column;
+  gap: 0.3rem;
+}
+
+.nav-item {
+  display: flex;
+  align-items: center;
+  gap: 12px;
+  padding: 0.6rem 0.8rem;
+  text-decoration: none;
+  color: var(--text-main);
+  border-radius: 6px;
+  transition: background 0.2s;
+}
+
+.nav-item:hover {
+  background-color: var(--border-color);
+}
+
+/* ================== Main Content Layout ================== */
+.main-content {
+  flex-grow: 1;
+  height: 100vh;
+  overflow-y: auto; /* Main Content ကို သီးခြား Scroll ဆင်းနိုင်စေရန် */
+  padding: 2rem 4rem;
+  scroll-behavior: smooth;
+}
+
+.header {
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  margin-bottom: 2rem;
+  padding-bottom: 1.5rem;
+  border-bottom: 1px solid var(--border-color);
+}
+
+.header h1 {
+  margin: 0;
+  color: var(--text-main);
+}
+
+.theme-toggle {
+  background: var(--bg-sidebar);
+  border: 1px solid var(--border-color);
+  color: var(--text-main);
+  padding: 0.5rem 1rem;
+  border-radius: 20px;
+  cursor: pointer;
+  font-weight: bold;
+  transition: all 0.2s;
+}
+
+.theme-toggle:hover {
+  background-color: var(--border-color);
+}
+
+/* ================== API Details Styling ================== */
+.api-section {
+  margin-bottom: 4rem;
+  scroll-margin-top: 2rem; /* Sidebar က လင့်ခ်နှိပ်ရင် ခေါင်းစဉ်ကွယ်မသွားအောင်ပါ */
+}
+
+.endpoint-header {
+  display: flex;
+  align-items: center;
+  gap: 15px;
+  margin-bottom: 1rem;
+}
+
+.path-text {
+  font-family: 'Courier New', Courier, monospace;
+  font-size: 1.6rem;
+  font-weight: bold;
+}
+
+.api-description {
+  color: var(--text-muted);
+  margin-bottom: 2rem;
+  font-size: 1.1rem;
+}
+
+.section-title {
+  font-size: 0.9rem;
+  text-transform: uppercase;
+  color: var(--primary-color);
+  letter-spacing: 1px;
+  margin-bottom: 1rem;
+  margin-top: 2.5rem;
+}
+
+/* Tags (GET, POST, etc.) */
+.method-tag {
+  font-size: 0.75rem;
+  font-weight: bold;
+  padding: 0.3rem 0.6rem;
+  border-radius: 4px;
+  color: white;
+  min-width: 50px;
+  text-align: center;
+  letter-spacing: 0.5px;
+}
+.method-tag.GET { background-color: #61affe; }
+.method-tag.POST { background-color: #49cc90; }
+.method-tag.PUT { background-color: #fca130; }
+.method-tag.DELETE { background-color: #f93e3e; }
+.method-tag.PATCH { background-color: #50e3c2; }
+
+/* Tables */
+.params-table {
+  width: 100%;
+  border-collapse: collapse;
+  margin-bottom: 1.5rem;
+}
+
+.params-table th, .params-table td {
+  text-align: left;
+  padding: 1rem;
+  border-bottom: 1px solid var(--border-color);
+}
+
+.params-table th {
+  background-color: var(--table-header);
+  font-size: 0.9rem;
+  color: var(--text-muted);
+  text-transform: uppercase;
+}
+
+.type-label {
+  font-family: monospace;
+  color: #61affe;
+}
+
+/* Code Blocks */
+.code-block {
+  background-color: var(--code-bg);
+  border: 1px solid var(--border-color);
+  border-radius: 8px;
+  padding: 1.5rem;
+  overflow-x: auto;
+}
+
+.code-block pre {
+  margin: 0;
+  font-family: 'Courier New', Courier, monospace;
+  font-size: 0.95rem;
+  line-height: 1.5;
+  color: var(--text-main);
+}
+
+/* Responsive */
+@media (max-width: 768px) {
+  .app-container { flex-direction: column; overflow: auto; }
+  .sidebar { width: 100%; height: auto; max-height: 40vh; border-right: none; border-bottom: 1px solid var(--border-color); }
+  .main-content { height: auto; padding: 1.5rem; overflow-y: visible; }
+  .path-text { font-size: 1.2rem; }
+}
+
+/* Tag Group Collapsible */
+.tag-group { margin-bottom: 0.5rem; }
+.tag-header { 
+  padding: 0.6rem 0.8rem; 
+  cursor: pointer; 
+  font-weight: bold; 
+  color: var(--text-main);
+  display: flex;
+  align-items: center;
+  gap: 8px;
+}
+.tag-header:hover { background-color: var(--border-color); }
+.tag-endpoints { padding-left: 1rem; }
+
+/* Tag Pills */
+.tag { 
+  background: var(--primary-color); 
+  color: white; 
+  padding: 0.2rem 0.5rem; 
+  border-radius: 12px; 
+  font-size: 0.75rem;
+  margin-right: 0.5rem;
+}
+.tag-list { margin-bottom: 1rem; }
+
+/* Auth Badge */
+.auth-badge { 
+  display: inline-block; 
+  background: #fca130; 
+  color: white; 
+  padding: 0.3rem 0.6rem; 
+  border-radius: 4px; 
+  font-size: 0.8rem;
+  margin-left: 1rem;
+}
+
+/* Try It Out */
+.try-it-out-btn {
+  background: var(--primary-color);
+  color: white;
+  border: none;
+  padding: 0.6rem 1.2rem;
+  border-radius: 6px;
+  cursor: pointer;
+  font-weight: bold;
+  font-size: 0.9rem;
+}
+.try-it-out-btn:hover { opacity: 0.9; }
+
+.response {
+  background: var(--code-bg);
+  border: 1px solid var(--border-color);
+  border-radius: 6px;
+  padding: 1rem;
+  margin-top: 1rem;
+  white-space: pre-wrap;
+  font-family: monospace;
+  font-size: 0.85rem;
+}
+.status { font-weight: bold; margin-top: 0.5rem; }
+.error { color: #f93e3e; }
+.loading { color: var(--text-muted); font-style: italic; }
+
+/* Global Settings */
+.settings-section {
+  background: var(--bg-sidebar);
+  padding: 1rem;
+  border-radius: 8px;
+  margin-bottom: 2rem;
+}
+.settings-section h3 { margin: 0 0 0.5rem 0; font-size: 0.9rem; }
+.settings-section div { display: flex; align-items: center; gap: 0.5rem; margin-bottom: 0.5rem; }
+.auth-input {
+  flex: 1;
+  padding: 0.5rem;
+  border: 1px solid var(--border-color);
+  border-radius: 4px;
+  background: var(--bg-main);
+  color: var(--text-main);
+}
+
+/* Request Body Form */
+.request-body-form {
+  background: var(--code-bg);
+  border: 1px solid var(--border-color);
+  border-radius: 8px;
+  padding: 1rem;
+  margin: 1rem 0;
+}
+.form-field {
+  margin-bottom: 1rem;
+}
+.form-field label {
+  display: block;
+  font-weight: bold;
+  margin-bottom: 0.3rem;
+  color: var(--text-main);
+}
+.field-desc {
+  display: block;
+  font-size: 0.85rem;
+  color: var(--text-muted);
+  margin-bottom: 0.3rem;
+}
+.form-input {
+  width: 100%;
+  padding: 0.6rem;
+  border: 1px solid var(--border-color);
+  border-radius: 4px;
+  background: var(--bg-main);
+  color: var(--text-main);
+  font-family: monospace;
+}
+.form-input:focus {
+  outline: none;
+  border-color: var(--primary-color);
+}
+
+/* Try It Out Button */
+.try-it-out-btn {
+  background: var(--primary-color);
+  color: white;
+  border: none;
+  padding: 0.6rem 1.2rem;
+  border-radius: 6px;
+  cursor: pointer;
+  font-weight: bold;
+  font-size: 0.9rem;
+  margin-right: 0.5rem;
+}
+.try-it-out-btn:hover { opacity: 0.9; }
+.try-it-out-btn.secondary { background: #007bff; }
+
+/* Response Section */
+.response-section {
+  margin-top: 1rem;
+}
+.response-section h4 {
+  margin: 0 0 0.5rem 0;
+  font-size: 0.9rem;
+}
+.response-body {
+  background: var(--code-bg);
+  border: 1px solid var(--border-color);
+  border-radius: 6px;
+  padding: 1rem;
+  margin: 0;
+  white-space: pre-wrap;
+  font-family: monospace;
+  font-size: 0.85rem;
+  max-height: 300px;
+  overflow-y: auto;
+}

package/install.sh

@@ -0,0 +1,109 @@
+#!/bin/bash
+# FroggyDocs Installation Script
+# Supports Linux, macOS, and Windows (via Git Bash)
+
+set -e
+
+INSTALL_DIR="${HOME}/.froggy-docs"
+BIN_DIR="${HOME}/.local/bin"
+REPO_URL="https://github.com/yourusername/froggy-docs/releases"
+VERSION="1.0.0"
+
+echo "🐸 FroggyDocs Installer v${VERSION}"
+echo "=================================="
+
+# Detect OS
+detect_os() {
+    case "$(uname -s)" in
+        Linux*)     echo "linux" ;;
+        Darwin*)   echo "macos" ;;
+        MINGW*|MSYS*) echo "windows" ;;
+        *)         echo "unknown" ;;
+    esac
+}
+
+# Get binary name
+get_binary_name() {
+    local os=$(detect_os)
+    case "$os" in
+        windows) echo "froggy-docs.exe" ;;
+        *)      echo "froggy-docs" ;;
+    esac
+}
+
+# Create directories
+setup_dirs() {
+    mkdir -p "$INSTALL_DIR"
+    mkdir -p "$BIN_DIR"
+}
+
+# Download and install binary
+install_binary() {
+    local os=$(detect_os)
+    local arch
+    local binary_name
+    local download_url
+
+    case "$os" in
+        linux)
+            arch="x86_64-linux-gnu"
+            ;;
+        mocos)
+            arch="x86_64-macos"
+            ;;
+        windows)
+            arch="x86_64-windows.zip"
+            ;;
+        *)
+            echo "❌ Unsupported OS"
+            exit 1
+            ;;
+    esac
+
+    binary_name=$(get_binary_name)
+    download_url="${REPO_URL}/download/v${VERSION}/froggy-docs-${arch}"
+
+    echo "📥 Downloading for $os..."
+
+    curl -L "$download_url" -o "${INSTALL_DIR}/${binary_name}"
+    chmod +x "${INSTALL_DIR}/${binary_name}"
+
+    echo "✅ Installed to ${INSTALL_DIR}/${binary_name}"
+}
+
+# Add to PATH
+add_to_path() {
+    echo ""
+    echo "📝 Adding to PATH..."
+    echo ""
+    echo "Add this line to your ~/.bashrc or ~/.zshrc:"
+    echo "   export PATH=\"\$PATH:${BIN_DIR}\""
+    echo ""
+    echo "Then run: source ~/.bashrc"
+}
+
+# Main
+main() {
+    setup_dirs
+    
+    if [ -f "${INSTALL_DIR}/froggy-docs" ] || [ -f "${INSTALL_DIR}/froggy-docs.exe" ]; then
+        echo "✅ FroggyDocs already installed"
+        echo "   Location: ${INSTALL_DIR}"
+        echo ""
+        echo "To update: rm -rf ${INSTALL_DIR} && $(basename $0)"
+    else
+        install_binary
+        add_to_path
+    fi
+
+    echo ""
+    echo "🎉 Installation complete!"
+    echo ""
+    echo "Usage:"
+    echo "  froggy-docs serve              Start documentation server"
+    echo "  froggy-docs serve -p 3000     Custom port"
+    echo "  froggy-docs serve -h 0.0.0.0  Make accessible on network"
+    echo "  froggy-docs watch            Watch for changes"
+}
+
+main "$@"

package/lib/froggy_docs.dart

@@ -0,0 +1,2 @@
+export 'src/watcher_engine.dart';
+export 'src/parser_engine.dart';

package/lib/src/mock.json

@@ -0,0 +1,5 @@
+{
+  "email": "user@example.com",
+  "age": 25,
+  "isAdmin": true
+}