Complete project management and control panel for Korus Framework in Visual Studio Code
Overview
Korus Framework Manager is a powerful VS Code extension that provides a comprehensive dashboard for managing Korus Java projects. Streamline your development workflow with integrated lifecycle management, build tools, testing, and more—all without leaving your editor.
Features
Project Management
- Automatic detection of Korus projects in workspace
- Real-time project status monitoring
- Quick project switching
- Built-in project generator with customizable templates
Lifecycle Control
- Start/Stop/Restart projects with one click
- Real-time status updates (Running, Stopped, Error)
- Clean project artifacts
- Port management and conflict detection
Build & Compilation
- Quick Compile - Fast incremental builds
- Clean Build - Full rebuild from scratch
- Full Build - Complete build with tests
- Verify Build - Run all validations
- Package - Create JAR artifacts
Source Code Explorer
- Hierarchical package structure view
- Create new Java classes with templates
- Create new packages
- Rename files and directories
- Delete with confirmation
- Quick file opening
Testing Integration
- Run all tests with one click
- Test results in integrated terminal
- Maven test lifecycle integration
Dependency Management
- Visual dependency tree
- Resolve dependencies
- Download sources
- Conflict detection
- View comprehensive project metadata
- Quick access to
pom.xml
- Edit
application.properties
- Component statistics
Code Generation Insights
- View Korus-generated registry files
- Count components by type
- Track project growth
Demo
Creating a New Project
- Click Korus icon in Activity Bar
- Click + button in Projects section
- Fill in project details
- Click Create Project
- Project appears automatically in Projects list
Managing Project Lifecycle
- Select your project from Projects list
- Navigate to Lifecycle section
- Click ▶️ Start Project to run
- Monitor real-time status updates
- Use ⏹️ Stop or 🔄 Restart as needed
Building Your Project
- Navigate to Build & Compilation section
- Choose build type:
- Quick Compile for fast builds
- Full Build for complete build
- Clean Build for fresh start
- Monitor progress in integrated terminal
Managing Source Files
- Expand Source Files section
- Navigate package structure
- Right-click to create new class or package
- Click any file to open in editor
- Use context menu for rename/delete
Quick Start
1. Open Korus Dashboard
Click the Korus icon in the Activity Bar (left sidebar).
2. Create Your First Project
- Click [+] button in Projects section.
- Enter project details:
- Click "Create Project".
3. Start Development
- Project auto-selects after creation.
- Navigate Source Files to create classes.
- Use Build tools to compile.
- Start project with Lifecycle controls.
Keyboard Shortcuts
| Shortcut |
Action |
| Ctrl+Shift+R |
Refresh Projects |
| Ctrl+Shift+N |
Create New Project |
Configuration
Maven Settings
The extension uses Maven Wrapper (mvnw) by default. Ensure your project has:
project-root/
├── mvnw (Unix)
├── mvnw.cmd (Windows)
└── .mvn/
└── wrapper/
└── maven-wrapper.properties
Java Version
Requires Java 17 or higher.
Windows:
setx JAVA_HOME "C:\Program Files\Java\jdk-21"
Mac/Linux:
bash export JAVA_HOME=/usr/lib/jvm/java-21-openjdk
Commands
All commands available via Command Palette (Ctrl+Shift+P):
Project Management
- Korus: Refresh Projects
- Korus: Create New Project
Lifecycle
- Korus: Start
- Korus: Stop
- Korus: Restart
- Korus: Clean
Build
- Clean Build: mvnw clean compile
- Quick Compile: mvnw compile
- Full Build: mvnw clean install
- Verify: mvnw verify
- Package: mvnw package
Testing
Dependencies
- Dependency Tree
- Resolve Dependencies
- Project Info
- Open pom.xml
- Open application.properties
Code Generation
- View Generated Registry
- Count Components
Requirements
- VS Code: Version 1.80.0 or higher
- Java: JDK 17 or higher
- Maven: 3.6+ (via Maven Wrapper)
- Operating System: Windows, macOS, or Linux
Troubleshooting
Projects Not Detected
- Ensure pom.xml exists in project root
- Click Refresh button in Projects section
- Check workspace folders are opened
Build Fails
- Verify Java version:
java -version
- Check JAVA_HOME environment variable
- Ensure Maven Wrapper is executable:
chmod +x mvnw
Start Project Doesn't Work
- Check port 8080 is available
- View terminal output for errors
- Ensure project is compiled: Run Quick Compile first
Acknowledgments
- Built for the Korus Framework community
- Inspired by Spring Boot Dashboard
Support
