Contributing

​

Welcome Contributors!

​

Getting Started

git clone https://github.com/sammwyy/mikumikubeam.git
cd mikumikubeam

make prepare

# Create proxies file (one per line)
echo "http://proxy1:8080" > data/proxies.txt

# Create user agents file (one per line)
echo "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36" > data/uas.txt

make all
make run-server

​

Development Workflow

​

Building Components

# Build everything (recommended)
make all

# Or build individually
make webclient    # Build React frontend
make cli          # Build CLI binary
make server       # Build server binary

​

Running Components

make run-server
# Or directly:
./bin/mmb-server

make run-cli ARGS="attack http_flood http://example.com"
# Or directly:
./bin/mmb-cli attack http_flood http://example.com --verbose

​

Cleaning Build Artifacts

make clean

​

Code Structure

​

Key Directories

• cmd/ - Main applications (CLI and server)
• internal/ - Core engine and attack implementations
• pkg/ - Shared packages and utilities
• web-client/ - React-based frontend

​

Types of Contributions

​

Bug Fixes

1. Check if an issue already exists
2. Create a new issue if needed with reproduction steps
3. Submit a PR with the fix
4. Include tests if applicable

​

New Attack Methods

​

Feature Enhancements

1. Open an issue to discuss the feature first
2. Get feedback from maintainers
3. Implement the feature
4. Submit a PR with documentation updates

​

Documentation

• Fix typos or unclear explanations
• Add examples and use cases
• Improve setup instructions
• Add troubleshooting guides

​

Coding Standards

​

Go Code

• Follow standard Go conventions and formatting
• Use gofmt to format your code
• Add comments for exported functions and types
• Keep functions focused and testable

// Good: Clear, focused function with documentation
// Fire sends a single HTTP flood request to the target
func (w *floodWorker) Fire(ctx context.Context, params core.AttackParams, 
    p core.Proxy, ua string, logCh chan<- core.AttackStats) error {
    // Implementation
}

​

React/TypeScript Code

• Use TypeScript for type safety
• Follow React best practices
• Keep components modular and reusable
• Use proper prop typing

​

Commit Messages

• Use clear, descriptive commit messages
• Start with a verb (Add, Fix, Update, Remove)
• Reference issue numbers when applicable

# Good commit messages
git commit -m "Add UDP flood attack method"
git commit -m "Fix proxy rotation bug in HTTP bypass"
git commit -m "Update documentation for CLI usage"

# Less ideal
git commit -m "fixes"
git commit -m "updates"

​

Pull Request Process

git checkout -b feature/udp-flood
git checkout -b fix/proxy-rotation

git add .
git commit -m "Add UDP flood attack method"
git push origin feature/udp-flood

​

Testing

​

Manual Testing

1. Test with --verbose flag to see detailed logs
2. Verify proxy rotation works correctly
3. Test with and without proxies (--no-proxy)
4. Ensure graceful error handling

# Test your new attack
./bin/mmb-cli attack your_method http://example.com --verbose --threads 4

​

Testing Multi-client Support

1. Open multiple browser tabs
2. Start different attacks simultaneously
3. Verify each client has isolated state
4. Check real-time stats update correctly

​

Prerequisites

​

Getting Help

• Open an issue for bugs or feature requests
• Check existing issues and discussions
• Review the documentation thoroughly

​

License