Rocket/site/guide.md

The Rocket Programming Guide

Welcome to Rocket!

This is the official guide. It is designed to serve as a starting point to writing web application with Rocket and Rust. The guide is also designed to be a reference for experienced Rocket developers. This guide is conversational in tone. For concise and purely technical documentation, 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: introduction to Rocket's structure 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 the #rocket IRC channel on the Mozilla IRC Server at irc.mozilla.org and the bridged Rocket room on Matrix. If you're not familiar with IRC, we recommend chatting through Matrix via Riot or via the Kiwi web IRC client. You can learn more about IRC via Mozilla's Getting Started with IRC guide.