warning icon This documentation is out of date. Go to current release. warning icon

Guide

The ins and outs of Rocket, in detail.

Quickstart#

Before you can start writing a Rocket application, you'll need a nightly version of Rust installed. We recommend you use rustup to install or configure such a version. If you don't have Rust installed and would like extra guidance doing so, see the getting started section.

Running Examples#

The absolute fastest way to start experimenting with Rocket is to clone the Rocket repository and run the included examples in the examples/ directory. For instance, the following set of commands runs the hello_world example:

1
2
3
4
5
git clone https://github.com/SergioBenitez/Rocket
cd Rocket
git checkout v0.3.17
cd examples/hello_world
cargo run

There are numerous examples in the examples/ directory. They can all be run with cargo run.