Skip to content

README.md

Latest commit

 

History

History
110 lines (84 loc) · 4.15 KB

README.md

File metadata and controls

110 lines (84 loc) · 4.15 KB

Fox Web Framework Website

Official documentation website for the Fox web framework, built with Astro and Starlight.

🌐 Live Site: https://fox-gonic.github.io

✨ Features

Fox is a powerful extension of Gin that provides:

  • 🚀 Automatic Parameter Binding - Bind parameters from URI, query strings, and JSON bodies with struct tags
  • 🌐 Multi-Domain Routing - Route traffic based on domain names with exact and regex pattern matching
  • 📝 Structured Logging - Built-in logger with TraceID, structured fields, and automatic file rotation
  • 🛡️ Crash Protection - Graceful panic recovery with detailed error logging and stack traces
  • ⚡ High Performance - Minimal overhead above Gin's routing engine
  • 🔌 Middleware Support - Full compatibility with Gin middleware ecosystem
  • ✅ Custom Validation - Implement IsValider interface for complex business validation logic
  • 🔄 100% Gin Compatible - Use any existing Gin middleware and handlers seamlessly

🚀 Project Structure

├── public/
├── src/
│   ├── assets/
│   │   └── fox-logo.svg
│   ├── content/
│   │   └── docs/
│   │       ├── index.mdx              # Homepage with feature showcase
│   │       ├── guides/                # Getting started documentation
│   │       │   ├── introduction.md
│   │       │   ├── quickstart.md
│   │       │   └── installation.md
│   │       ├── features/              # Core features documentation
│   │       │   ├── binding.md
│   │       │   ├── multi-domain.md
│   │       │   ├── logging.md
│   │       │   └── validation.md
│   │       ├── api/                   # API reference
│   │       │   ├── router.md
│   │       │   └── context.md
│   │       ├── examples/              # Code examples
│   │       │   └── basic.md
│   │       └── zh-cn/                 # Chinese translations (11 files)
│   └── styles/
│       └── custom.css
├── astro.config.mjs
├── package.json
└── tsconfig.json

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command Action
npm install Installs dependencies
npm run dev Starts local dev server at localhost:4321
npm run build Build your production site to ./dist/
npm run preview Preview your build locally, before deploying

🌐 Supported Languages

  • English (en)
  • Simplified Chinese (zh-CN)

📝 Documentation Structure

The documentation is organized into four main sections:

  • Getting Started: Introduction, Quick Start, Installation
  • Features: Parameter Binding, Multi-Domain Routing, Structured Logging, Validation
  • API Reference: Router, Context
  • Examples: Basic Usage

All content is available in both English and Simplified Chinese.

🎨 Customization

The website uses a custom CSS file (src/styles/custom.css) to match the design of gin-gonic.com, featuring:

  • Dark theme by default
  • Colorful feature cards (orange, green, red, blue)
  • Gradient effects
  • Responsive design

⚙️ Technical Details

Dependencies:

  • Astro v5.16.15
  • Starlight v0.37.4
  • TypeScript v5.7.3
  • Sharp v0.34.5 (image optimization)

Development:

  • Full TypeScript support with strict type checking
  • Hot module replacement (HMR) for fast development
  • Optimized production builds with automatic asset optimization

📄 License

MIT License - see the LICENSE file for details

🔗 Links