Rocket/site/guide/index.md

The Rocket Programming Guide

Welcome to Rocket!

This is the official guide for Rocket v0.5. It is designed to serve as a starting point to writing web applications with Rocket and Rust. The guide is also designed to be a reference for experienced Rocket developers. This guide is conversational in tone. For purely technical documentation with examples, see the API documentation.

The guide is split into several sections, each with a focus on a different aspect of Rocket. The sections are:

• Introduction: introduces Rocket and its philosophy.
• Quickstart: presents the minimal steps necessary to run your first Rocket application.
• Getting Started: a gentle introduction to getting your first Rocket application running.
• Overview: describes the core concepts of Rocket.
• Requests: discusses handling requests: control-flow, parsing, and validating.
• Responses: discusses generating responses.
• State: how to manage state in a Rocket application.
• Fairings: provides an overview of Rocket's structured middleware.
• Testing: how to unit and integration test a Rocket application.
• Configuration: how to configure a Rocket application.
• Pastebin: a tutorial on how to create a pastebin with Rocket.
• Conclusion: concludes the guide and discusses next steps for learning.

Getting Help

The official community support channels are #rocket:mozilla.org on Matrix and the bridged #rocket IRC channel on Libera.Chat at irc.libera.chat. We recommend joining us on Matrix via Element. If you prefer IRC, you can join via the Kiwi IRC client or a client of your own.