Skip to content

al-sultani/prokzee

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

2 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

ProKZee

Built with Wails React TypeScript License Go Version PRs Welcome GitHub Issues GitHub Stars

A powerful and modern cross-platform desktop application for HTTP/HTTPS traffic interception and analysis, built with Go and React.

Features β€’ Installation β€’ Usage β€’ Development β€’ Contributing β€’ Docker Support β€’ Issues β€’ Roadmap β€’ License β€’ Author

ProKZee Screenshot

✨ Features

  • πŸ” Intercept and analyze HTTP/HTTPS traffic
  • πŸš€ Built with Go and React for maximum performance
  • πŸ’» Modern and intuitive user interface
  • πŸ›  Powerful traffic manipulation tools
  • πŸŒ“ Dark and light theme support
  • πŸ”„ Request resender for quick retesting
  • πŸ§ͺ Fuzzer for security testing and vulnerability discovery
  • πŸͺ Interactsh integration for out-of-band testing
  • πŸ€– AI-powered analysis with ChatGPT integration
  • πŸ“± Cross-platform support (Windows, macOS, Linux)

πŸš€ Installation

Prerequisites

  • Go 1.17 or later
  • Node.js 14 or later
  • npm or yarn

Quick Start

  1. Download the latest release for your platform from the releases page
  2. Run the installer or extract the archive
  3. Launch ProKZee

🎯 Usage

πŸ’» Development

Setting Up the Development Environment

Local Development

  1. Clone the repository:
git clone https://github.com/al-sultani/prokzee.git
cd prokzee
  1. Install dependencies:
# Install frontend dependencies
cd frontend
npm install
cd ..

# Install Go dependencies
go mod tidy

Docker Development (Recommended)

For the easiest setup, use our Docker development environment:

docker-compose up dev

See the Docker Support section for more details.

Running in Development Mode

Local

wails dev

Docker

docker-compose up dev

This will:

  • Start a Vite development server for the frontend
  • Enable hot reload for frontend changes
  • Provide access to Go methods via http://localhost:34115

Building for Production

Local Build

wails build

Docker Build (Recommended)

docker-compose run build

The built application will be available in the build/bin directory.

🐳 Docker Support

Prerequisites

  • Docker
  • Docker Compose

Development with Docker

Run the development environment with hot-reload:

docker-compose up dev

This will:

  • Start a development container with all necessary dependencies
  • Enable hot-reload for both frontend and backend changes
  • Mount your local source code into the container
  • Expose ports:
    • 8080 (Proxy)
    • 3000 (Frontend dev server)
    • 34115 (Wails debug port)

Building with Docker

Build the production version:

docker-compose run build

The built application will be available in the build/ directory.

Cross-Platform Builds

Build for specific platforms:

# For Windows
GOOS=windows GOARCH=amd64 docker-compose run build

# For macOS
GOOS=darwin GOARCH=amd64 docker-compose run build

# For Linux
GOOS=linux GOARCH=amd64 docker-compose run build

Docker Configuration Files

The project includes several Docker-related files:

  • Dockerfile - Production build configuration
  • Dockerfile.dev - Development environment configuration
  • docker-compose.yml - Service definitions and container orchestration
  • .dockerignore - Excludes unnecessary files from builds

Build Cache and Volumes

The setup uses Docker volumes to optimize build times:

  • go-mod-cache: Caches Go modules
  • node-modules: Caches npm packages

🀝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

πŸ› Issues and Feedback

We're constantly working to improve ProKZee and value your input! Please feel free to:

  • Open issues for any bugs you encounter
  • Submit feature requests or enhancement ideas
  • Provide feedback on existing functionality
  • Suggest UI/UX improvements
  • Report documentation issues

To submit an issue, please visit our Issues page and provide as much detail as possible to help us understand and address your concerns.

πŸ—ΊοΈ Roadmap

Check out our Roadmap to see what features and improvements are planned for future releases.

πŸ“ License

This project is provided under a custom license that combines elements of the Commons Clause with additional restrictions. The license:

  • βœ… Allows free use, modification, and distribution
  • βœ… Permits creating derivative works
  • βœ… Requires attribution
  • ❌ Prohibits commercial resale
  • ❌ Prohibits selling the software as a service

See the LICENSE file for the complete terms.

πŸ‘¨β€πŸ’» Author

Abdullah Al-Sultani


Made with ❀️ using Wails

About

A cross-platform desktop application for HTTP/HTTPS traffic interception and analysis, built with Go. Features modern UI, traffic manipulation tools, request resending, fuzzing capabilities, and AI-powered analysis.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors