WIZ Framework

Modern Full-Stack Web Development Framework

Features • Quick Start • Documentation • Examples • Contributing

---

📖 Overview

WIZ is a powerful full-stack web development framework that combines Python backend with Angular frontend, providing an integrated development environment (IDE) for rapid web application development. Built on Flask and Angular, WIZ simplifies the development workflow with its intuitive web-based IDE and comprehensive plugin system.

Why WIZ?

• 🚀 Rapid Development - Create full-stack applications with minimal boilerplate
• 🎨 Web-Based IDE - Develop directly in your browser with a modern, feature-rich IDE
• 🤖 MCP & AI Agent Ready - CLI commands designed for AI-powered automation
• 🔌 Plugin Architecture - Extend functionality with a powerful plugin system
• 📦 Built-in Tools - Git integration, npm/pip management, live preview, and more
• 🌐 Full-Stack - Python backend (Flask) + Angular frontend seamlessly integrated
• 🔧 Flexible Configuration - Easy project configuration and management

✨ Features

Core Features

• Web-Based IDE - Full-featured development environment accessible through your browser
• Hot Reload - Instant preview of changes during development
• Multiple Projects - Manage multiple projects within a single workspace
• Component Generator - Quickly scaffold pages, components, and services
• API Development - Streamlined backend API development with Flask
• Portal Framework - Create and manage reusable module packages

Built-in Tools

• 📁 File Explorer - Browse and manage project files
• 💻 Code Editor - Monaco-based editor with syntax highlighting and autocomplete
• 🔍 Search & Replace - Powerful search across your entire project
• 🌳 Git Integration - Version control directly in the IDE
• 📦 Package Management - npm and pip package management UI
• 🖼️ Asset Preview - Preview images and other assets
• 🤖 AI Assistant - GPT-powered coding assistant (optional)

Developer Experience

• TypeScript Support - Full TypeScript support for Angular development
• Pug Templates - Option to use Pug for cleaner HTML templates
• TailwindCSS - Built-in support for TailwindCSS
• Socket.IO - Real-time communication support
• WSGI Compatible - Production-ready WSGI deployment

🚀 Quick Start

Prerequisites

• Python 3.8 or higher
• Node.js 14 or higher
• npm

Installation

1. Install Node.js and npm (if not already installed):

apt install nodejs npm
npm i -g n
n stable
apt purge nodejs npm

2. Install WIZ:

pip install season             # Install
pip install season --upgrade   # Upgrade to latest

Create Your First Project

# Create a new project
cd <workspace>
wiz create myapp
cd myapp

# Start development server
wiz run --port 3000

# Open your browser to http://127.0.0.1:3000/wiz

Development Mode

# Start development server with custom settings
wiz run --host=0.0.0.0 --port=3000 --log=wiz.log

Production Mode

# Start as daemon
wiz server start
wiz server stop
wiz server restart

# Register as system service (Linux)
wiz service regist myapp
wiz service start myapp

Upgrade

pip install season --upgrade  # Upgrade core framework
wiz ide upgrade               # Upgrade IDE components

📚 Documentation

Comprehensive documentation is available in multiple languages:

• English Documentation - Complete guide in English

  • Usage Guide - Getting started and development guide
  • Architecture - Framework design and internals
  • API Reference - Complete API documentation
  • Examples - Practical examples and tutorials

• 한국어 문서 - 한국어 완전 가이드

  • 사용 가이드 - 시작 및 개발 가이드
  • 아키텍처 - 프레임워크 설계 및 내부 구조
  • API 레퍼런스 - 전체 API 문서
  • 예제 모음 - 실전 예제 및 튜토리얼

💻 CLI Reference

Basic Commands

wiz create <name>              # Create new workspace
wiz run [--port=PORT]          # Start development server
wiz bundle [--project=NAME]    # Create production bundle
wiz kill                       # Kill all WIZ processes

Project Management

wiz project list                              # List all projects
wiz project build --project=main              # Build project
wiz project create --project=dev              # Create new project
wiz project delete --project=dev              # Delete project
wiz project export --project=main --output=backup.wizproject

App Management

wiz project app list --project=main           # List apps
wiz project app create --project=main --app=page.home --engine=pug
wiz project app delete --project=main --app=page.home

Controller & Route Management

wiz project controller list --project=main    # List controllers
wiz project controller create --project=main --controller=api
wiz project route list --project=main         # List routes
wiz project route create --project=main --route=custom --path=/api/v1

Package & NPM Management

wiz project package list --project=main       # List portal packages
wiz project npm install --project=main --package=lodash
wiz project npm list --project=main           # List npm packages

Daemon Management

wiz server start [--log=PATH] [--force]   # Start daemon
wiz server stop                            # Stop daemon
wiz server restart                         # Restart daemon

Service Management (Linux)

wiz service list                          # List all services
wiz service regist <name> [port]          # Register service
wiz service unregist <name>               # Unregister service
wiz service status <name>                 # Check service status
wiz service start [name]                  # Start service(s)
wiz service stop [name]                   # Stop service(s)
wiz service restart [name]                # Restart service(s)

IDE Commands

wiz ide install                           # Install IDE
wiz ide upgrade                           # Upgrade IDE
wiz ide build                             # Build IDE
wiz ide clean                             # Clean IDE cache

For complete CLI documentation, see Command Guide (English) | 명령어 가이드 (한국어)

🤖 MCP & AI Agent Integration

WIZ v2.5+ provides CLI commands designed for seamless integration with AI agents and MCP (Model Context Protocol) servers:

# AI agents can programmatically manage projects
wiz project list                              # Discover available projects
wiz project app list --project=main           # List all components
wiz project app create --project=main --app=page.dashboard --engine=pug
wiz project build --project=main --clean      # Build with clean cache

# Export/Import for project portability
wiz project export --project=main --output=project.wizproject
wiz project create --project=new --path=project.wizproject

Key Benefits for AI Automation:

• ✅ Structured command output for machine parsing
• ✅ Comprehensive project lifecycle management
• ✅ Modular subcommand architecture
• ✅ Export/Import support for project sharing
• ✅ All commands accessible without web IDE

🎯 Examples

Creating a Simple API

# In your controller file (e.g., controller/api.py)
def index(wiz):
    return wiz.response.json({"message": "Hello, WIZ!"})

Creating an Angular Component

Use the built-in IDE to:

1. Navigate to the workspace explorer
2. Click "New Component"
3. Enter component details
4. The framework automatically generates the component structure

For more examples, see the Examples Documentation.

🏗️ Architecture

WIZ follows a modular architecture:

project/
├── app/                    # Angular applications
│   ├── component.ts        # Component logic
│   ├── view.pug           # Component template (Pug)
│   └── view.html          # Component template (HTML)
├── controller/            # Backend controllers
├── model/                 # Data models
├── route/                 # Custom routes
├── portal/                # Reusable modules
└── config/                # Configuration files

For detailed architecture information, see Architecture Documentation.

🔌 Plugin System

WIZ supports a powerful plugin system for extending functionality:

• Core Plugins - Essential IDE functionality
• Workspace Plugins - Project management and file operations
• Git Plugins - Version control integration
• Utility Plugins - Additional tools and features
• Custom Plugins - Create your own plugins

📋 Version Policy

WIZ follows semantic versioning (x.y.z):

• x (Major): Breaking changes - upgrade not supported
• y (Minor): New features - requires server restart
• z (Patch): UI updates - can be upgraded without restart

📝 Release Notes

See RELEASES.md for the latest updates and complete version history.

Quick links to version-specific releases:

• Version 2.5.x (Current) - MCP/Agent Ready CLI, Project Management Tools
• Version 2.4.x - Angular 18, TailwindCSS, AI Assistant
• Version 2.3.x - Bundle structure, Angular 17
• Version 2.2.x - IDE overlay menu
• Version 2.1.x - IDE plugin concept
• Version 2.0.x - Angular 14, UI/UX redesign
• Version 1.0.x and earlier - Legacy releases

🤝 Contributing

We welcome contributions! Please feel free to submit issues and pull requests.

Development Setup

1. Clone the repository

git clone https://github.com/season-framework/wiz.git
cd wiz

2. Install dependencies

pip install -r requirements.txt

3. Run in development mode

cd src
python -m season.cmd run

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Built with Flask and Angular
• Code editor powered by Monaco Editor
• Terminal powered by xterm.js

📞 Support

• Issues: GitHub Issues
• Documentation: docs/

---

Made with ❤️ by the WIZ Framework Team

⬆ Back to Top