Browser Installation
This guide covers installation options for the WTTP Browser, including pre-built Windows releases and development setup for all platforms.
Windows Installation (Recommended)
Pre-built Release
The easiest way to get started is with our pre-built Windows installer:
-
Download the Latest Release
- Visit the WTTP Browser Releases page
- Download the latest Windows installer (
.exefile) - Current version: v4.0.1 (Pre-alpha release)
-
Install the Browser
- Run the downloaded installer
- Follow the installation wizard
- The browser will be installed to your default applications folder
-
Launch the Browser
- Find "Min" in your Start Menu or desktop
- Launch the application
- Start browsing Web3 content immediately!
System Requirements
- Operating System: Windows 10 or later
- Architecture: x64 (64-bit) or ARM64
- Memory: 4GB RAM minimum, 8GB recommended
- Storage: 200MB free space
- Network: Internet connection for blockchain access
Development Installation
For developers who want to build from source or contribute to the project:
Prerequisites
- Node.js: Version 16 or later (Download Node.js)
- Git: For cloning the repository
- Platform-specific tools (see below)
Clone and Setup
-
Clone the Repository
git clone https://github.com/TechnicallyWeb3/min-web3.git
cd min-web3 -
Install Dependencies
npm install -
Start Development Mode
npm run start
Platform-Specific Setup
Windows Development
Required Tools:
- Visual Studio: Install Visual Studio with C++ build tools
- Python: Install Python 2.7 (required for native modules)
Setup Commands:
# Set Visual Studio version (adjust year as needed)
npm config set msvs_version 2019
# Install dependencies
npm install
# Start development
npm run start
macOS Development
Required Tools:
- Xcode: Install Xcode and command-line tools
- macOS SDK: Version 11.0 or higher
Setup Commands:
# Set SDK path (adjust version as needed)
export SDKROOT=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX11.1.sdk
# Install dependencies
npm install
# Start development
npm run start
Linux Development
Required Tools:
- Build Essentials:
sudo apt-get install build-essential - Python:
sudo apt-get install python2.7 - Node.js: Install via NodeSource repository
Setup Commands:
# Install build tools (Ubuntu/Debian)
sudo apt-get update
sudo apt-get install build-essential python2.7
# Install dependencies
npm install
# Start development
npm run start
Building Binaries
To create distributable binaries for your platform:
Windows Build
npm run buildWindows
macOS Builds
# Intel Macs
npm run buildMacIntel
# Apple Silicon Macs
npm run buildMacArm
Linux Builds
# Debian/Ubuntu
npm run buildDebian
# Red Hat/CentOS
npm run buildRedhat
# AppImage (universal Linux)
npm run buildAppImage
Development Workflow
- Make Changes: Edit the source code
- Reload UI: Press
Alt+Ctrl+R(orOpt+Cmd+Ron Mac) to reload the browser UI - Test Changes: Your modifications will be reflected immediately
- Build Release: Use the appropriate build command when ready
Configuration
Network Configuration
The WTTP Browser uses Sepolia testnet by default. To configure different networks:
- Default Chain: Sepolia (11155111)
- Supported Networks: See the Modifications Guide for full list
- Custom RPC: Configure in the WTTP Handler settings
Environment Variables
For development, you can set these environment variables:
# Custom RPC endpoint
export WTTP_RPC_URL=https://sepolia.infura.io/v3/YOUR_PROJECT_ID
# Custom chain ID
export WTTP_CHAIN_ID=11155111
# Debug mode
export WTTP_DEBUG=true
Troubleshooting
Common Issues
Installation Fails
- Windows: Ensure you have Visual Studio installed
- macOS: Check Xcode command-line tools are installed
- Linux: Install build-essential package
Protocol Not Working
- Check Network: Ensure you have internet connection
- RPC Issues: Verify your RPC endpoint is working
- Chain ID: Confirm the correct chain ID is configured
Build Errors
- Node Version: Ensure you're using Node.js 16+
- Dependencies: Run
npm installagain - Clean Build: Try
npm run buildfirst
Getting Help
- GitHub Issues: Report bugs or ask questions
- Documentation: Check the WTTP Documentation
- Community: Join our Discord for support
Debug Mode
Enable debug mode to see detailed logs:
# Windows
set DEBUG=wttp:*
npm run start
# macOS/Linux
DEBUG=wttp:* npm run start
Next Steps
Once you have the WTTP Browser installed:
- Try Example Sites: Visit some Web3 examples
- Deploy Your Own: Learn how to deploy WTTP sites
- Develop Applications: Use the WTTP Handler in your projects
Security Notes
Pre-built Releases
- Verification: Always download from official GitHub releases
- Antivirus: Some antivirus software may flag the installer (false positive)
- Permissions: The installer may require administrator privileges
Development Builds
- Code Review: Always review code before building
- Dependencies: Keep dependencies updated for security patches
- Network Security: Use HTTPS RPC endpoints in production
The WTTP Browser is designed to be secure by default, but always exercise caution when downloading and installing software from the internet.