Chapter 2: Installation Deep Dive for Ruby
In this chapter, we will go deep into the installation process. By the end, you will have a fully configured development environment with hot reload, debugging, and all the tools you need.
System Requirements
Kungfu.js has two components:
- The Rust core: Handles HTTP, routing, middleware. Needs Rust 1.96+ installed.
- The Ruby binding: Lets you write handlers in Ruby. Needs the Ruby runtime.
You need Ruby 3+ with the ffi gem and Rust.
Step 1: Install Rust
Rust is required because it compiles the HTTP server engine. Even if you write in Ruby, the server itself runs Rust code.
# On macOS or Linux:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# On Windows:
# Download rustup-init.exe from https://rustup.rs
Verify Rust is installed:
rustc --version
# Should print: rustc 1.96+
Step 2: Install the Ruby Binding
Now install the Kungfu.js package for Ruby:
gem install kungfu
Step 3: Verify the Installation
Create a test file and run it to make sure everything works:
require 'kungfu'
app = Kungfu::App.new
app.get('/hello') { |req| [200, {}, ['world']] }
app.listen(3000)
Run it:
ruby app.rb
If you see "world" at http://localhost:3000/hello, your installation is complete.
Common Installation Problems
Problem: "command not found: rustc"
Rust is not in your PATH. Run source $HOME/.cargo/env or restart your terminal.
Problem: "port 3000 already in use"
Another application is using port 3000. Either stop that app or use a different port: .listen(3001)
Problem: Build fails with "linker not found"
You need a C linker installed. On Ubuntu: sudo apt install build-essential. On macOS: xcode-select --install.
Development Environment Setup
For the best development experience, install the Kungfu.js VSCode extension. It provides:
- Syntax highlighting for
.jskand.tskfiles - Code snippets (type
kgetand press Tab) - The green hexagon icon for Kungfu.js files
What is Next?
In chapter 3, we will dissect the Hello World code line by line, explaining every function, every parameter, and why things work the way they do.