mirror of
https://github.com/Heretek-AI/heretek-openclaw-docs.git
synced 2026-07-01 13:18:20 -04:00
Heretek OpenClaw Frontend
🚀 Modern frontend for the Heretek OpenClaw autonomous agent collective
A comprehensive, user-friendly interface built with Next.js that provides documentation and access to the Heretek OpenClaw agent collective.
🌟 Features
Core Functionality
- 📚 Documentation Hub: Centralized documentation for all OpenClaw features
- 📱 Responsive Design: Mobile-first approach with modern UI/UX
- 🔍 Navigation: Easy navigation through architecture, API, deployment, and operations docs
- 🌙 Dark/Light Mode: Theme switching with system preference detection
- ⚡ Performance Optimized: Static site generation for lightning-fast loading
Technical Features
- 🎨 Modern UI Components: Built with Radix UI and shadcn/ui
- 📈 Data Visualization: Charts and metrics using Chart.js
- 🔄 State Management: React Query for efficient data fetching
- 📝 Type Safety: Full TypeScript implementation
- 🚀 Static Export: Optimized for GitHub Pages deployment
🛠️ Tech Stack
Frontend Framework
- Next.js 15.5.8 - React framework with App Router
- React 19.2.3 - Latest React with concurrent features
- TypeScript 5.9.3 - Type-safe JavaScript
Styling & UI
- Tailwind CSS 3.4.17 - Utility-first CSS framework
- Radix UI - Unstyled, accessible UI components
- shadcn/ui - Re-usable components built on Radix UI
- Framer Motion - Animation library
- Lucide React - Icon library
State Management
- TanStack Query 5.90.12 - Powerful data synchronization
- Zod 4.2.1 - TypeScript-first schema validation
- nuqs 2.8.5 - Type-safe search params state manager
🚀 Getting Started
Prerequisites
- Node.js 20+ (recommend using the latest LTS version)
- npm, yarn, pnpm, or bun package manager
- Git for version control
Installation
-
Clone the repository
git clone https://github.com/heretek/heretek-openclaw.git cd heretek-openclaw/frontend -
Install dependencies
# Using npm npm install # Using yarn yarn install # Using pnpm pnpm install # Using bun bun install -
Start the development server
npm run dev -
Open your browser
Navigate to http://localhost:3000 to see the application running.
🧪 Development
Available Scripts
# Development
npm run dev # Start development server with Turbopack
npm run build # Build for production
npm run start # Start production server (after build)
# Code Quality
npm run lint # Run ESLint
npm run typecheck # Run TypeScript type checking
Configuration for Static Export
The application is configured for static export in next.config.mjs:
const nextConfig = {
output: "export",
basePath: "/heretek-openclaw",
images: {
unoptimized: true // Required for static export
}
};
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
🔗 Links
- 🌐 Live Website: https://heretek.github.io/heretek-openclaw/
- 💬 Discord Server: https://discord.gg/3AnUqsXnmK
- 📝 Main Repository: https://github.com/heretek/heretek-openclaw
Made with ❤️ by the Heretek team